Kanzi 3.9.10
kanzi Namespace Reference

Namespaces

namespace  android_ws
 
namespace  chrono
 
namespace  egl
 
namespace  emscripten
 
namespace  errc
 
namespace  interop
 
namespace  interpolation
 
namespace  numbers
 
namespace  placeholders
 
namespace  qnx
 
namespace  this_thread
 
namespace  wayland
 
namespace  win32
 
namespace  windowing
 
namespace  x11
 

Classes

class  AbstractAnimation
 Interface for abstract animations. More...
 
class  AbstractBinding
 AbstractBinding is the base class for binding classes. More...
 
class  AbstractBindingRuntime
 Base class for binding runtimes. More...
 
class  AbstractBindingVariableSource
 Abstract interface for VariableBindingSources and VariableExpressionValueSource. More...
 
class  AbstractExpressionValueSource
 Value source base for use in bindings with multiple sources. More...
 
class  AbstractExpressionValueSourceRuntime
 Runtime base class for expression value sources. More...
 
class  AbstractIndexedRange
 Abstract indexed range interface. More...
 
class  AbstractLogger
 To implement a logger, inherit from this class. More...
 
class  AbstractMessageType
 AbstractMessageType is a homogeneous message type handle to an existing message type. More...
 
class  AbstractMessageTypeDescriptor
 An instance of a AbstractMessageTypeDescriptor represents a single message type in the Kanzi message system in an abstract homogeneous form. More...
 
class  AbstractNodeReference
 
class  AbstractProfiler
 AbstractProfiler. More...
 
class  AbstractPropertyNotificationHandler
 Abstract property notification handler. More...
 
class  AbstractPropertyType
 AbstractPropertyType is a homogeneous property type handle to an existing property type. More...
 
class  AbstractPropertyTypeDescriptor
 AbstractPropertyTypeDescriptor is used internally by the property type system to manage property types. More...
 
class  AbstractRange
 Abstract range interface. More...
 
class  AbstractRangeIterator
 Abstract range iterator interface. More...
 
class  AbstractRangeLocation
 Location into a range. More...
 
class  AbstractResourceReference
 
class  AbstractValueProfiler
 Abstract value profiler. More...
 
class  Action
 Actions are small operations that Kanzi executes when the trigger event that contains that action occurs and the trigger conditions are met. More...
 
class  ActionBase
 Base abstraction class for Action classes. More...
 
class  Activity2D
 An Activity is a part of application UI that is responsible for a task. More...
 
class  Activity3D
 An Activity is a part of application UI that is responsible for a task. More...
 
class  ActivityBrowserController
 ActivityBrowserController is an interface class for implementing runtime data exchange between the Kanzi Studio Preview and the ActivityBrowser Kanzi Studio plugin. More...
 
class  ActivityCodeBehind
 ActivityCodeBehind is code that is associated with a particular Activity node, and has access to the properties of that Activity node. More...
 
class  ActivityConcept
 Base class for Activity classes. More...
 
class  ActivityConceptImpl
 Implementation class for ActivityConcept. More...
 
class  ActivityElement
 ActivityElement is the base class for all Activity and Activity Host classes. More...
 
class  ActivityElementHistory
 Encapsulates serialized data for activity elements. More...
 
class  ActivityElementImpl
 ActivityElement implementation class. More...
 
class  ActivityHistoryManager
 ActivityHistoryManager encapsulates functionality of serialization of activities. More...
 
class  ActivityHostConcept
 Base class for Activity Host classes. More...
 
class  ActivityHostConceptImpl
 Implementation class for ActivityHostConcept. More...
 
class  ActivityHostControllerPropertyManager
 Encapsulates management of activities through a controller property. More...
 
class  ActivityPrefabLoader
 Helper class for the Activity Host class types. More...
 
class  ActivitySourceController
 Encapsulates the management of data provider for Data-Driven Exclusive Activity Host. More...
 
class  ActivityStatusAnimationFinishedHandler
 Encapsulates dispatching of messages when an activating or a deactivating activity animation is finished. More...
 
class  ActivityStatusManager
 Covers the management of the StatusProperty in the State Manager that the prefab of an Activity node uses for transition animations. More...
 
class  ActivitySwitchingSynchronizer
 Encapsulates the synchronization of animations for activating and deactivating Activity nodes. More...
 
class  AndroidLogger
 
class  AnimationBindingProcessor
 Animation binding processor executes an animation and calculates the value for use in expression bindings. More...
 
class  AnimationBindingProcessorRuntime
 Holds the runtime state of an AnimationBindingProcessor. More...
 
class  AnimationPlayer
 Use the Animation Player to play back an animation timeline that you set using the TimelineProperty property in that Animation Player. More...
 
class  AnimationResource
 A Resource wrapper class for animations. More...
 
class  Application
 Application class is the base class for Kanzi applications. More...
 
struct  ApplicationProperties
 Configurable application properties. More...
 
struct  AppliedStyleEntry
 Applied style entry. More...
 
class  ApplyAction
 Base abstraction for Actions for DataTrigger, such as ForwardingApplyAction and ApplyActivationAction. More...
 
class  ApplyActivationAction
 An ApplyActivationAction keeps an Activity node activated for as long as the condition is met in a DataTrigger that contains this action. More...
 
class  ApplyPropertyAction
 An ApplyPropertyAction sets a property to the requested value for as long as the condition is met in the DataTrigger that sets off this action. More...
 
class  AutoClosingModalScope
 Implements the auto-closing modal scopes. More...
 
class  AutoClosingModelessScope
 Implements the auto-closing modeless focus scope. More...
 
struct  BackEasingFunction
 Changes the value back slightly before moving it toward the target. More...
 
struct  BezierEasingFunction
 Changes the value according to a Bezier curve. More...
 
class  BinaryResource
 
class  Binding
 Binding is the simplest form of binding. More...
 
class  BindingBaseRuntime
 Base runtime class for simple one-on-one bindings. More...
 
struct  BindingExpressionOpCode
 Expression binding operation. More...
 
struct  BindingExpressionOpCodeParameters
 Runtime Parameters for binding expression opcodes. More...
 
class  BindingHostConcept
 BindingHostConcept specifies an interface for adding and removing bindings to the binding host. More...
 
class  BindingHostConceptImpl
 Implementation class for BindingHostConcept. More...
 
struct  BindingLoadInfo
 Use the BindingLoadInfo to create the information for a binding that you need when adding the binding to an object. More...
 
class  BindingLookupContext
 Lookup context for bindings. More...
 
class  BindingLookupNotificationBase
 Base class for notifications on binding lookup. More...
 
class  BindingNodeEffect2DLookupContext
 Binding lookup context for NodeEffect2D. More...
 
class  BindingNodeLookupContext
 Binding lookup context for Node. More...
 
class  BindingProcessor
 Binding processor. More...
 
class  BindingProcessorRuntime
 Holds the runtime state of a binding processor. More...
 
class  BindingRenderPassLookupContext
 Binding lookup context for RenderPass. More...
 
class  BindingRenderValueLookupContext
 Binding lookup context for render value associations. More...
 
class  BindingRuntime
 Runtime for binding. More...
 
class  BindingRuntimeHandle
 Handler for binding runtimes. More...
 
class  BindingSource
 Binding source contains all the persistent data that you need to access a source value for the binding. More...
 
class  BindingSourceRuntime
 Binding source runtime interface. More...
 
class  BindingTargetRuntime
 Binding target runtime interface. More...
 
class  BindingToken
 Helper class that manages the lifetime of the runtime binding owned by a Node or a RenderPass, by removing the owned binding on the destruction of that Node or the RenderPass. More...
 
class  BindingTriggerLookupContext
 Binding lookup context for Node. More...
 
class  BindingValueSourceOwner
 Owner for value source bindings. More...
 
class  BitmapFontFile
 Font implementation for bitmap fonts. More...
 
class  BitmapFontLoader
 FontLoader implementation for bitmap fonts. More...
 
class  BitmapImage
 Image is the basic runtime primitive to load, hold, and convert image data in memory. More...
 
class  BlendModeRenderStatePropertyNotificationHandler
 Custom render state property notification handler for blend mode. More...
 
class  BlendModeRenderValueBindingTargetRuntime
 Custom render value binding target runtime for blend mode. More...
 
class  BlitRenderPass
 Use the Blit Render Pass to blit one or more textures to the screen of the current rendering context using a material. More...
 
class  BlurEffect2D
 Use BlurEffect2D to apply a Gaussian blur post-processing effect to 2D nodes. More...
 
class  BlurEffectRenderer2D
 Blur effect renderer class. More...
 
struct  BounceEasingFunction
 Changes the value as a sequence of bounces. More...
 
class  Box
 Class for box volume. More...
 
class  Brush
 Use a brush to fill a Node2D. More...
 
class  BrushRenderer
 An interface for specialized brush renderers, which implement brush rendering. More...
 
class  BufferObjectStream
 Specifies stream to GL buffer object. More...
 
class  Button2D
 Use the Button 2D node to create a 2D UI control that the user can interact with through clicking, tapping, or pressing a key. More...
 
class  Button3D
 Use the Button 3D node to create a 3D UI control that the user can interact with through clicking, tapping, or pressing a key. More...
 
class  ButtonConcept
 Button nodes provide an area that receives key and touch input which Kanzi translates to state events. More...
 
class  ButtonConceptImpl
 Implementation class for ButtonConcept. More...
 
class  CallbackBindingProcessor
 Callback processor. More...
 
class  CallbackProcessorRuntime
 Holds the runtime state of a CallbackBindingProcessor. More...
 
class  Camera
 Use a Camera to define the view transform to use to render a 3D Scene. More...
 
struct  CharacterLayout
 Structure for layout of a single character for text rendering. More...
 
struct  CircleEasingFunction
 Changes the value using a circular function. More...
 
class  ClassPropertyDefaultValue
 ClassPropertyDefaultValue is a helper for installing property values as class metadata. More...
 
class  ClearRenderPass
 Use a Clear Render Pass to clear the color, depth, and stencil buffers of the current render context before passing the control to the descendants of this render pass. More...
 
class  ClickConcept
 Use the ClickConcept properties to control how nodes handle click and double-click. More...
 
class  ClickConceptImpl
 Implementation of base Click Concept class for derived classes. More...
 
class  ClickManipulator
 Click input manipulator recognizes the click and tap gestures from the incoming touch events. More...
 
class  ClickManipulatorComponent
 ClickManipulatorComponent installs a ClickManipulator to a node. More...
 
class  Clock
 Represents a monotonic, high resolution clock that advances steadily as the physical time moves forward. More...
 
class  CodeBehind
 Code Behind is a workflow where you associate code with an instance of a node instead of a type. More...
 
class  CodeBehindRegisterGuard
 RAII class for attaching code behind to an Activity or Activity Host node. More...
 
class  ColorBrush
 Color brush class. More...
 
class  ColorBrushRenderer
 Color brush renderer class. More...
 
class  ColorRGBA
 Color with 4 floating point components: red, green, blue and alpha (r, g, b, a). More...
 
class  CombinerObjectSource
 Combiner object source. More...
 
class  CombinerObjectSourceRuntime
 Runtime for combiner object source. More...
 
class  Command
 Command class defines property and message types used in implementation of commands. More...
 
class  CompositionBrush
 Texture brush class. More...
 
class  CompositionBrushRenderer
 OpenGL texture brush renderer class. More...
 
struct  CompositionContentRequirements
 Holds the requirements for the composition target. More...
 
class  CompositionManager
 Composition manager. More...
 
class  CompositionRequirements
 Composition requirements represent the required buffers for composition. More...
 
class  CompositionStack
 Composition stack for managing current render context. More...
 
class  CompositionTargetRenderPass
 Use the Composition Target Render Pass to set one to four composition targets and render all descendant render passes to the composition targets that the Composition Target Render Pass created. More...
 
class  Condition
 Condition for triggers. More...
 
class  ConstraintBindingProcessor
 Binding processor structure for constraints. More...
 
struct  ConstraintBindingProcessorRuntime
 Holds the runtime state of a ConstraintBindingProcessor. More...
 
class  Constraints
 Contains property types of Constraints. More...
 
class  ContainsPropertyFilter
 Use the Contains Property Filter to collect 3D nodes that contain, or do not contain a specific property. More...
 
class  ContainsPropertyFilterRuntime
 Runtime for contains property node filter. More...
 
class  ContentBrush
 Texture brush class. More...
 
class  ContentBrushRenderer
 Content brush renderer class. More...
 
class  ContentItemCollectionModel
 Base class for exposing abstract access to collections of items of UI controls with content. More...
 
class  ContentItemModel
 Base class for exposing abstract access to content of UI controls with single content item model. More...
 
class  ContentLayout2D
 Use the Content Layout 2D node to present content in a 2D UI control as a single item. More...
 
class  ContentLayout3D
 Use the Content Layout 3D node to present content in a 3D UI control as a single item. More...
 
class  ContentLayoutConcept
 Use the Content Layout nodes to present complex content as one element in the UI. More...
 
class  ContentLayoutConceptImpl
 ContentLayoutConceptImpl is an abstract class for implementing the Content Layout node concept. More...
 
class  ContentReference
 
class  ControllerPropertySource
 Abstract class whose implementation encapsulates management of controller property source for an activity host controller property. More...
 
class  CoutLogger
 This logger class writes log messages to standard output. More...
 
class  CubeMapRenderPass
 Use the Cubemap Render Pass to create a cubemap texture that represents the scene from some location. More...
 
struct  CubicEasingFunction
 Changes the value based on the cube of time using the function f(t) = t^3. More...
 
class  CurveReparametrization
 Kanzi uses curve reparametrization to subdivide a spline or a line into a series of samples. More...
 
class  DataContext
 DataContext acts as a container for data. More...
 
class  DataDrivenExclusiveActivityHost2D
 A type of Exclusive Activity Host node, that uses a list of Activity nodes provided by setting a list DataObject, from a DataSource, to the ActivitySourceProperty property. More...
 
class  DataDrivenExclusiveActivityHost3D
 A type of Exclusive Activity Host node, that uses a list of Activity nodes provided by setting a list DataObject, from a DataSource, to the ActivitySourceProperty property. More...
 
class  DataDrivenExclusiveActivityHostConcept
 Base class for the Data-Driven Exclusive Activity Host classes. More...
 
class  DataDrivenExclusiveActivityHostImpl
 Implementation class for DataDrivenExclusiveActivityHostConcept and ExclusiveActivityHostConcept. More...
 
class  DataObject
 DataObject is the base class for data. More...
 
class  DataObjectBool
 Implementation of DataObjectTyped<bool, DataObject::Bool>. More...
 
class  DataObjectEnum
 Provides functions to the host, set, and get values of the given type. More...
 
class  DataObjectEnumBase
 DataObjectEnumBase is the base class for enum data. More...
 
class  DataObjectInt
 Implementation of DataObjectTyped<int32_t, DataObject::Int>. More...
 
class  DataObjectList
 DataObjectList is the base class for list data object. More...
 
class  DataObjectReal
 Implementation of DataObjectTyped<double, DataObject::Real>. More...
 
class  DataObjectString
 Implementation of DataObjectTyped<string, DataObject::String>. More...
 
class  DataObjectTyped
 Template class that you can use with the standard types. More...
 
struct  DataObjectTypeTraits
 DataObjectTypeTraits Provides type information for how a data type should be stored, passed as a parameter, etc. More...
 
struct  DataObjectTypeTraits< double >
 A specialization for double, because PropertyDataTypeTraits<T> does not have double. More...
 
class  DataSource
 Use data sources to separate the user interface from the application data and to remove the dependencies between a Kanzi Studio project and the application code which define the Kanzi application. More...
 
class  DataSourceBindingSource
 Data source binding source. More...
 
class  DataSourceBindingSourceRuntime
 Runtime for object property binding source. More...
 
class  DataSourceControllerPropertySource
 Implementation of ControllerPropertySource, for controller property value provided by a data source field. More...
 
class  DataSourceExpressionValueSource
 Data Source expression value source. More...
 
class  DataSourceExpressionValueSourceRuntime
 Runtime for object property expression value source. More...
 
class  DataSourceListItemGenerator
 
class  DataSourceListItemGenerator2D
 
class  DataSourceListItemGenerator3D
 
class  DataTrigger
 Use a DataTrigger to apply an action to either set a property value of a target node or activate an Activity node. More...
 
class  DataTriggerComponent
 Base class for the DataTrigger class. More...
 
class  DataTriggerTemplate
 DataTriggerTemplate is the base class for the Data Trigger templates. More...
 
class  DebugRenderRegistry
 Use the debug render registry to register debug rendering functions for your custom Node3D nodes. More...
 
class  DefaultListBoxItemContainerGenerator
 
class  DefaultListBoxItemGenerator
 
class  DefaultLogger
 Use this class to access the Default Logger. More...
 
class  DefaultProfilerRegistry
 The default profiler registry placeholder. More...
 
class  DispatchMessageAction
 DispatchMessageAction dispatches a message of specified type to a specified target. More...
 
class  DistanceFilter
 Distance filter. More...
 
class  DistanceFilterRuntime
 Runtime for distance filter. More...
 
class  DockLayout2D
 Use the Dock Layout 2D node to place nodes relative to each other along the sides of a Dock Layout 2D node. More...
 
class  DockLayout3D
 Use the Dock Layout 3D node to place nodes relative to each other along the sides of a Dock Layout 3D node. More...
 
class  DockLayoutConcept
 Dock layout concept base class. More...
 
class  DockLayoutConceptImpl
 Dock layout concept implementation base class. More...
 
class  Domain
 Domain binds Kanzi subsystems and objects together. More...
 
class  DomainProfilerCollection
 The domain profiler collection. More...
 
class  DragAndDropManipulator
 Drag-and-drop input manipulator recognizes the drag-and-drop gesture from incoming touch events. More...
 
class  DrawObjectsRenderPass
 Use the Draw Objects Render Pass to render only nodes in a Scene node provided by an object source you set in this render pass. More...
 
class  DrawObjectsWithMaterialRenderPass
 Use the Draw Objects With Material Render Pass to render nodes provided by an object source using a material. More...
 
class  DummyBindingTargetRuntime
 Runtime for dummy binding target. More...
 
class  DynamicMessageType
 DynamicMessageType is a handle to an existing message type. More...
 
class  DynamicPropertyType
 DynamicPropertyType is a handle to an existing property type. More...
 
class  EffectStack2D
 Use EffectStack2D to apply multiple post-processing effects to 2D nodes. More...
 
class  EffectStackRenderer2D
 Use the Effect Stack Renderer to render a sequence of child effect renderers. More...
 
struct  EGLCapabilities
 EGL capabilities. More...
 
class  EGLConfig
 Class representing a single EGL configuration. More...
 
class  EGLContext
 Class representing an EGL context. More...
 
class  EGLDisplay
 Class representing an EGL display connection. More...
 
class  EGLPBufferSurface
 Class representing EGL PBuffer surface. More...
 
class  EGLPixmapSurface
 Class representing EGL pixmap surface. More...
 
struct  EGLVersion
 Struct holding EGL version information. More...
 
class  EGLWindowSurface
 Class representing EGL window surface. More...
 
struct  ElasticEasingFunction
 Changes the value that resembles an oscillating spring until it comes to rest. More...
 
class  EmptyNode2D
 Empty Node 2D can be used to group other 2D nodes. More...
 
class  EmptyNode3D
 
struct  enable_bitmask_operators
 Enabler template for bitmask operators over an Enum class. More...
 
class  EventFilter
 EventFilter class. More...
 
class  EventQueue
 The EventQueue class implements a queue of Kanzi input events gathered by EventSource instances. More...
 
class  EventSource
 EventSource class. More...
 
class  EventSourceDecorator
 The EventSourceDecorator declares the interface for the EventSource decorators. More...
 
struct  EventSourceProperties
 Configurable event source properties. More...
 
class  ExampleApplication
 
class  ExclusiveActivityHost2D
 An Activity Host that displays Activity nodes one at a time. More...
 
class  ExclusiveActivityHost3D
 An Activity Host that displays Activity nodes one at a time. More...
 
class  ExclusiveActivityHostBaseImpl
 Implementation of common functionality of ExclusiveActivityHost and DataDrivenExclusiveActivityHost classes. More...
 
class  ExclusiveActivityHostConcept
 This is the base class for all Exclusive Activity Host nodes. More...
 
struct  ExclusiveActivityHostContentHandler
 Helper class used to modify the ExclusiveActivityHostContent of an ExclusiveActivityHost. More...
 
class  ExclusiveActivityHostImpl
 Implementation class for ExclusiveActivityHost. More...
 
class  ExecuteLuaAction
 You can use ExecuteLuaAction to run a Lua script that implements application logic. More...
 
struct  ExponentialEasingFunction
 Changes the value with an exponential function with power that you can configure. More...
 
class  ExpressionBinding
 ExpressionBinding enables you to bind from multiple sources to one target, and to modify the values before writing them to target values. More...
 
class  ExpressionBindingProcessor
 Expression binding processor. More...
 
class  ExpressionBindingRuntime
 Runtime for expression binding. More...
 
class  ExpressionBindingSource
 Expression binding source collects expression value sources and executes operations on the values to produce a read result. More...
 
class  ExpressionBindingSourceRuntime
 Runtime for expression binding source. More...
 
class  ExpressionCondition
 Use trigger conditions to set which conditions must be met for a Trigger to set off. More...
 
class  File
 Interface class for files. More...
 
class  FilterObjectSource
 Filter object source. More...
 
class  FilterObjectSourceRuntime
 Base class for filter runtime classes. More...
 
class  FixedString
 String that points to a string literal. More...
 
class  FlagScopeGuard
 Scope guard for boolean value. More...
 
class  FloatValueAccumulator
 Use a FloatValueAccumulator to increase the value of a float property type or a property field over time. More...
 
class  FlowLayout2D
 Flow Layout 2D arranges 2D items along a line and continues to the next line when it runs out of space. More...
 
class  FlowLayout3D
 Flow Layout 3D arranges 3D items along a line and continues to the next line when it runs out of space. More...
 
class  FlowLayoutConcept
 Flow layout concept base class. More...
 
class  FlowLayoutConceptImpl
 Flow layout concept implementation base class. More...
 
struct  FocusChainIndex
 Contains the focus order and focus order offset information of a node in a focus scope. More...
 
struct  FocusChainNode
 The focus chain node of a focus scope consists of the node of the focus scope, its focus order, and the focus order offset. More...
 
class  FocusFence
 Implements the focus fences. More...
 
class  FocusGroup
 Implements the focus groups. More...
 
class  FocusManager
 Focus Manager enables you to set and change the key focus between attached nodes. More...
 
struct  FocusNavigationGesture
 Declares a focus navigation gesture. More...
 
class  FocusNavigationManipulator
 FocusNavigationManipulator converts key gestures into focus chain navigation actions to move the focus between focusable nodes. More...
 
class  FocusScope
 The FocusScope class holds the attributes of a focus scope: More...
 
class  FocusScopeVisitor
 Focus scope visitor for UI scene traversal of focus scopes. More...
 
class  FontEnginePlugin
 FontEnginePlugin is the interface definition for font engine plugins. More...
 
class  FontFamily
 A font family resource contains font files. More...
 
class  FontFile
 FontFile is the base class for different font file resource implementations. More...
 
class  FontLoader
 Use FontLoader to create FontFile objects from memory or a file. More...
 
class  FontManager
 Use the FontManager class to: More...
 
class  FontRuntime
 Runtime font. More...
 
class  FontStyleConcept
 FontStyleConcept is the base class for the nodes that draw text with different font styles. More...
 
class  FontStyleConceptImpl
 Implementation class for FontStyleConcept. More...
 
class  FontStyleDefinition
 FontStyleDefinition provides a collection of font characteristics. More...
 
class  ForwardingAction
 ForwardingAction is the base class for the action classes that read and send arguments, such as SetPropertyAction or DispatchMessageAction. More...
 
class  ForwardingApplyAction
 ForwardingApplyAction is the base class for the ApplyAction classes that read and send an argument, such as ApplyPropertyAction. More...
 
class  Framebuffer
 Framebuffer attachment state. More...
 
class  FrameDescription
 Description of a frame, the remaining area of a quad with another quad cut out. More...
 
class  FrameTimeQueue
 Helper class for calculating the frame rate. More...
 
class  FreeTypeFontEnginePlugin
 FreeTypeFontEnginePlugin is the FreeType font engine plugin implementation. More...
 
class  FreeTypeFontFile
 Font implementation using the Freetype rasterizer. More...
 
class  FreeTypeFontLoader
 FontLoader implementation for the Freetype rasterizer. More...
 
class  FreeTypeTextShaper
 TextShaper implementation using these open source libraries: More...
 
struct  from_chars_result
 Holds the status result of a call to from_chars. More...
 
class  FromToAnimation
 Template class for from-to animations. More...
 
class  FromToAnimationBase
 Template base class for from-to animations. More...
 
class  FrustumCullFilter
 Frustum cull filter. More...
 
class  FrustumCullFilterRuntime
 Runtime for frustum cull filter. More...
 
class  GatherLightsRenderPass
 GatherLightsRenderPass is a class for generating light properties for rendering nodes. More...
 
class  GatherNearestLightsRenderPass
 GatherNearestLightsRenderPass is an implementation of light gathering. More...
 
class  GenericResourceProfilingContext
 Generic resource profiling context. More...
 
class  Geometry
 Geometry represents 2D coordinate data that you can use to render 2D nodes and text. More...
 
class  GlBlendModeRenderValue
 Custom blend mode render value implementation. More...
 
class  GLBufferHandle
 GLBufferHandle manages RAII ownership for GL buffer object. More...
 
class  GLFramebufferHandle
 GLFramebufferHandle manages RAII ownership for GL framebuffer object. More...
 
class  GlGraphicsAdapter
 Base class for handling calls to OpenGL family. More...
 
class  GlGraphicsAdapterCallGles
 OpenGL API call handler which calls the implementation from dynamically loaded GLES library. More...
 
class  GlGraphicsAdapterCheckForErrors
 Check for GL errors. More...
 
class  GlGraphicsAdapterLogger
 Logs OpenGL API calls. More...
 
class  GlGraphicsLogScope
 Scoped OpenGL log enable/disabler. More...
 
class  GLGraphicsOutput
 GLGraphicsOutput class. More...
 
class  GLProgramHandle
 GLProgramHandle manages RAII ownership for GL program object. More...
 
class  GLRenderbufferHandle
 GLRenderbufferHandle manages RAII ownership for GL renderbuffer object. More...
 
class  GlRenderState
 OpenGL render state. More...
 
class  GlRenderValue
 Individual render value container. More...
 
class  GlRenderValue< TextureSharedPtr >
 Specialization of GlRenderValue. More...
 
class  GlRenderValueBase
 Base class for render value information. More...
 
struct  GlRenderValueBinding
 GlRenderValueBinding is a binding from shaders/materials into values in GlRenderState. More...
 
class  GLShaderHandle
 GLShaderHandle manages RAII ownership for GL shader object. More...
 
class  GLTextureHandle
 GLTextureHandle manages RAII ownership for GL texture object. More...
 
class  GlyphCache
 Glyph cache renders different characters on a texture with the font and font size that you use in your Kanzi application. More...
 
class  GlyphCacheManager
 GlyphCacheManager creates and maintains glyph caches for different font file and font size combinations. More...
 
class  GlyphRun
 GlyphRun contains the memory structures that are needed to render a text string. More...
 
class  GPUBuffer
 
class  GPUResource
 GPUResource is a resource that must be deployed to the GPU. More...
 
class  GraphicsOutput
 GraphicsOutput class. More...
 
class  GridLayout2D
 Grid Layout 2D arranges 2D items in a grid. More...
 
class  GridLayout3D
 Grid Layout 3D arranges 3D items in a grid. More...
 
class  GridLayoutConcept
 Base class for the Grid Layout nodes. More...
 
class  GridLayoutConceptImpl
 Implementation class for GridLayoutConcept. More...
 
class  GridListBox2D
 Use the Grid List Box 2D node to create scrollable lists of 2D items arranged in a grid. More...
 
class  GridListBox2DTraits
 
class  GridListBox3D
 Use the Grid List Box 3D node to create scrollable lists of 3D items arranged in a grid. More...
 
class  GridListBox3DTraits
 
class  GridListBoxConcept
 GridListBoxConcept provides the common properties and messages for the GridListBox2D and GridListBox3D nodes. More...
 
class  HudDebugEvent
 The event toggles the head-up display debugging status. More...
 
class  Image2D
 Image2D node. More...
 
class  ImmutableIteratorRange
 Iterator location range pointing to a particular location of an iterator range. More...
 
class  ImmutableSplitStringRange
 ImmutableSplitStringRange is an analogue to the ImmutableIteratorRange for a SplitStringRange. More...
 
class  ImmutableString
 Immutable string container. More...
 
class  IndexedPropertyAccessRange
 Indexed property access range. More...
 
class  IndexedViewRange
 View over another indexed range. More...
 
class  InputEvent
 Base event class providing the core functionality of the Kanzi input events. More...
 
class  InputManager
 Input Manager converts the events from the given event queue into input specific messages. More...
 
class  InputManipulator
 The base class for the Kanzi input manipulators. More...
 
class  InputMethod
 The InputMethod class defines the interface of the Kanzi input methods. More...
 
class  InputMethodBackend
 The InputMethodBackend defines the interface of the input method backends. More...
 
class  InputMethodListener
 The InputMethodListener defines the communication interface of Kanzi input methods. More...
 
class  InputMethodManager
 The InputMethodManager keeps track of the input method backends registered in Kanzi. More...
 
class  Instantiator3D
 Use the Instantiator node to replicate the appearance of a 3D node, or a tree of 3D nodes, that the Instantiator node targets. More...
 
class  InstructionBindingProcessor
 Instruction binding processor is the top-level class for all instruction-like binding processors. More...
 
class  InstructionBindingProcessorRuntime
 Holds the runtime state of an InstructionBindingProcessor. More...
 
class  InterpolatedValue
 Core component for smooth interpolation in code. More...
 
class  IntervalProfiler
 The interval profiler. More...
 
struct  IntervalProfilerSampleData
 The interval profiler data sample. More...
 
struct  IntervalProfilerSampleStatistics
 
class  IntervalProfilingSampler
 The main loop task profiling sampler collects interval measurement to produce IntervalProfilerSampleData sample. More...
 
class  IntValueAccumulator
 Use an IntValueAccumulator to increase the value of an integer property type over time. More...
 
class  InvalidKZBFileException
 Kanzi throws this exception when it tries to load an invalid kzb file. More...
 
struct  IrisImageHeader
 
class  IteratorRange
 Iterator is an range that references a location in another range. More...
 
class  ItypeFontEnginePlugin
 ItypeFontEnginePlugin is the IType font engine plugin implementation. More...
 
class  ItypeFontFile
 Font implementation using the iType rasterizer. More...
 
class  ItypeFontLoader
 FontLoader implementation for Monotype's iType rasterizer. More...
 
class  ItypeTextShaper
 TextShaper implementation using Monotype's WTShaper library. More...
 
class  JavaException
 Exception class that can be used to wrap a Java generated exception. More...
 
class  JavaModule
 
class  JNIError
 
struct  JniLibrary
 
class  JvmModule
 
class  KanziComponentsModule
 
class  Keyboard
 Keyboard declares the messages dispatched to the nodes when Kanzi handles a hardware key event. More...
 
class  KeyEvent
 The KeyEvent holds a pressed, released, or auto-repeated key event that occurs in the host operating system. More...
 
class  KeyframeAnimation
 Template class for keyframe animations. More...
 
struct  KeyGestureInfo
 This class defines the elements that compose a key gesture, key values, and key modifiers. More...
 
class  KeyManipulator
 KeyManipulator class is a key input manipulator that detects key gestures. More...
 
class  KeyManipulatorComponent
 The KeyManipulatorComponent node component installs a KeyManipulator to the attached node, and configures the key gesture of the manipulator. More...
 
struct  KeyMap
 Defines the keys to map from a {LogicalKey, KeyModifier} pair to a simple LogicalKey. More...
 
class  KeyMapEventFilter
 The KeyMapEventFilter provides key translation in Kanzi. More...
 
class  KeyRepeatGenerator
 The KeyRepeatGenerator is an event source decorator that scans the event queue of the EventSource it extends for key-press events and generates from them key-press repetitions. More...
 
class  KzbFile
 Kzb file loader. More...
 
class  KZBFileException
 Kanzi throws this exception when an error occurs while loading a kzb file. More...
 
class  KzbMemoryParser
 Parser for kzb files. More...
 
class  LegacyError
 
class  LegacyEventSource
 LegacyEventSource class. More...
 
class  LegacyGraphicsOutput
 LegacyGraphicsOutput class. More...
 
class  LegacyRenderPass
 Legacy Render Pass is phased out in favor of specialized render passes that perform individual operations, which are combined in a Legacy Render Pass into a single render pass. More...
 
class  LevelOfDetail3D
 Level of detail selector node is a 3D node that changes the appearance of its child nodes based on the viewing distance. More...
 
struct  LibJPEGParameters
 Parameters that Kanzi passes to libjpeg to use when loading jpg image files. More...
 
struct  LibPNGParameters
 Parameters that Kanzi passes to libpng to use when loading png image files. More...
 
class  Light
 Light node is a source of light for a 3D scene. More...
 
struct  LinearEasingFunction
 Changes the value with constant velocity. More...
 
class  ListBoxConcept
 Properties and messages for list boxes. More...
 
class  ListBoxConceptImpl
 ListBoxConceptImpl provides the common base implementation for the List Box nodes, such as GridListBox2D, GridListBox3D, and TrajectoryListBox3D. More...
 
class  ListBoxGridPresenter
 
class  ListBoxItemContainer
 Use the List Box Item Container prefab to create common functionality and decoration for all items in a List Box. More...
 
class  ListBoxItemContainer2D
 List Box Item Container for 2D List Box nodes. More...
 
class  ListBoxItemContainer3D
 List Box Item Container for 3D List Box nodes. More...
 
class  ListBoxItemContainerGenerator2D
 
class  ListBoxItemContainerGenerator3D
 
class  ListBoxItemContainerImpl
 Implementation of base List Box Item Container class for List Box. More...
 
class  ListBoxItemGenerator2D
 
class  ListBoxItemGenerator3D
 
class  ListBoxScrollingConcept
 Messages for the List Box nodes that implement scrolling. More...
 
class  ListBoxScrollPresenterConceptImpl
 ListBoxScrollPresenterConceptImpl is the base class concept implementation for the List Box presenters that use Scroll View in their presentation. More...
 
class  ListBoxTrajectoryPresenter
 
class  LongPressManipulator
 Long-press input manipulator recognizes the long-press gesture from the incoming touch events. More...
 
class  LongPressManipulatorComponent
 LongPressManipulatorComponent installs a LongPressManipulator to a node. More...
 
class  LuaInstance
 Loads and runs Lua scripts. More...
 
class  LuaModule
 The Lua plugin enables you to program Kanzi applications using the Lua programming language. More...
 
class  MainLoopProfiler
 MainLoopProfiler implements profiling for tasks of MainLoopScheduler. More...
 
class  MainLoopProfilingAggregateData
 MainLoopProfilingAggregateData implements profiling data aggregation for MainLoopProfiler. More...
 
struct  MainLoopProfilingSampleData
 MainLoopProfilingSampleData implements profiling sample data for MainLoopProfiler. More...
 
class  MainLoopProfilingSampler
 MainLoopProfilingSampler implements profiling sampler for MainLoopProfiler. More...
 
class  MainLoopScheduler
 MainLoopScheduler implements the Kanzi application main loop in form of a customizable sequence of stages, each consisting of a sequence of tasks, where a task is any callable, including functions, function objects, and lambdas. More...
 
class  ManualBinding
 Manual binding is a one-to-one binding that caches the value that was written to the target. More...
 
class  ManualBindingRuntime
 Runtime for binding. More...
 
class  ManualBindingSource
 Manual binding source. More...
 
class  ManualBindingSourceRuntime
 Runtime for manual binding source. More...
 
class  ManualBindingTargetRuntime
 Runtime for manual binding target. More...
 
class  MaskEffect2D
 Use MaskEffect2D to apply a mask to 2D nodes. More...
 
class  MaskEffectRenderer2D
 Mask effect renderer class. More...
 
class  Material
 A material is an instance of a material type (ShaderProgram) that contains the property values for the material type properties. More...
 
class  MaterialBrush
 Freeform shader brush. More...
 
class  MaterialBrushRenderer
 Material brush renderer. More...
 
class  MaterialSetupRenderPass
 Use the Material Setup Render Pass to set properties to a material for further render operations using that material. More...
 
class  Matrix3x3
 Matrix with 3x3 elements. More...
 
class  Matrix4x4
 Matrix with 4x4 elements. More...
 
class  MemoryParser
 
class  MemoryWriter
 
class  Mesh
 Mesh stores the geometry data for rendering Model3D nodes. More...
 
class  MeshVertexAttribute
 MeshVertexAttribute describes how Kanzi stores mesh vertex and instance data in memory. More...
 
class  MessageArguments
 MessageArguments is the base class for arguments passed in messages. More...
 
class  MessageBindingSource
 Message binding source. More...
 
class  MessageBindingSourceRuntime
 Runtime for message binding source. More...
 
class  MessageBindingTargetRuntime
 Runtime for message binding target. More...
 
class  MessageTrigger
 Message handler trigger. More...
 
class  MessageType
 An instance of a MessageType represents a single message type in the Kanzi message system. More...
 
class  Metaclass
 Metaclass provides type inspection mechanism for Kanzi classes. More...
 
class  MetaclassAbstractBase
 
class  MetaclassAbstractImpl
 
class  MetaclassImpl
 
class  MetaclassStaticBase
 
class  MetaclassStaticImpl
 
class  MetadataGeneratedName
 This class is used to disambiguate a constructor which takes a non-literal string argument from an overload which takes a string-literal i.e. FixedString. More...
 
class  MetaMethod
 MetaMethod provides method invocation mechanism for Kanzi classes. More...
 
class  MetaObject
 MetaObject is the base class for classes that provide type reflection. More...
 
class  MethodArgument
 Holds argument type and value information. More...
 
class  MethodArguments
 Holds arguments applied on metamethod invocation. More...
 
class  MipmapGenerationConcept
 Use the MipmapGenerationConcept properties to control mipmap generation material of a Render Pass. More...
 
class  MipmapGenerationConceptImpl
 Implementation of base Mipmap Generation Concept class for derived classes. More...
 
class  ModalScope
 Implements the modal scopes. More...
 
class  Model3D
 Node for rendering meshes in 3D space. More...
 
class  ModelessScope
 Implements the modeless overlay focus scopes. More...
 
class  Module
 Module is a class representing a functional module with its own metadata about the types it contains. More...
 
struct  ModuleDeleter
 Module deleter for shared_ptr. More...
 
class  Morph
 
class  MorphRuntime
 Contains morph weights for a morph. More...
 
class  MorphWeightTimeline
 Timeline for animating morph weights. More...
 
class  MorphWeightTimelinePlayback
 Timeline Playback for morph timeline. More...
 
class  MoveFocusAction
 Use the MoveFocusAction action to transfer focus from the currently focused item to another focusable item in the focus navigation chain. More...
 
class  MultiClickManipulator
 Multi-click input manipulator recognizes multi-click and multi-tap gestures from incoming touch events. More...
 
class  MultiClickManipulatorComponent
 MultiClickManipulatorComponent installs a MultiClickManipulator to a node. More...
 
class  NamedIntervalProfiler
 The named interval profiler. More...
 
struct  NamedIntervalProfilerSampleData
 The named interval profiler data sample. More...
 
class  NamedIntervalProfilerSampler
 This sampler collects interval measurement to produce NamedIntervalProfilerSampleData sample. More...
 
struct  NamedIntervalProfilerSampleStatistics
 Named Interval profiler sample statistics. More...
 
class  NamedResourceProfilingContext
 Named resource profiling context. More...
 
class  NativeDeploymentTarget
 Reference to a backend implementation specific memory storage type for deployment. More...
 
struct  NativeDesktopProperties
 Properties for a desktop. More...
 
struct  NativeWindowProperties
 Properties for a window. More...
 
struct  NavigationGesture
 Declares a navigation gesture. More...
 
class  NavigationManipulator
 The NavigationManipulator supports these navigation directions and default keyboard keys for them: More...
 
class  NavigationManipulatorComponent
 The NavigationManipulatorComponent node component installs a NavigationManipulator to a node, and configures the navigation key gestures of the manipulator. More...
 
class  NinePatchImage2D
 A nine-patch image is a 3x3 grid of images. More...
 
class  Node
 Base class for Kanzi nodes. More...
 
class  Node2D
 Node2D is the base class of 2D nodes. More...
 
class  Node3D
 Base class for all 3D nodes. More...
 
class  NodeComponent
 NodeComponent is the base class for all node components. More...
 
class  NodeComponentTemplate
 NodeComponentTemplate is the base class for all node component templates. More...
 
class  NodeCompositor2D
 Composition functionality for 2D nodes. More...
 
class  NodeEffect2D
 Use node effects to apply post-processing effects to 2D nodes. More...
 
class  NodeEffectPrefab2D
 Use node effect prefabs to create node effects that define post-processing effects for 2D nodes. More...
 
class  NodeEffectRenderer2D
 Node effect renderer class. More...
 
class  NodeEffectTemplate2D
 Use NodeEffectTemplate2D to instantiate a node effect. More...
 
class  NodeList
 NodeList is a container that works as input and output node listing for filtering and rendering. More...
 
class  NodeListRenderPass
 Use the Node List Render Pass to filter and hold a list of nodes that you want to render using other render passes. More...
 
class  NodePropertyNotificationHandler
 Node property notification handler. More...
 
class  NodeReference
 Provides functionality for a reference to any attached node that you can access using a relative path. More...
 
class  NodeVisual2D
 Data and functionality required for rendering Node2D visuals. More...
 
class  NullBrush
 Null brush class. More...
 
class  NullGraphicsOutput
 NullGraphicsOutput class. More...
 
class  nullptr_t
 nullptr_t is the type of the null pointer literal, nullptr. More...
 
class  Object
 Object is the base class for Kanzi UI classes that implement association with a Domain. More...
 
class  ObjectControllerPropertySource
 Implementation of the ControllerPropertySource, for ControllerProperty value provided as a property field, either on the Activity Host node or, if the Activity Host node does not have that property, its nearest ancestor that does have that property. More...
 
class  ObjectFactory
 
class  ObjectLoader
 ObjectLoader loads objects from KZB. More...
 
class  ObjectPropertyBindingSource
 Object property binding source. More...
 
class  ObjectPropertyBindingSourceRuntime
 Runtime for ObjectPropertyBindingSource. More...
 
class  ObjectPropertyExpressionValueSource
 Object Property expression value source. More...
 
class  ObjectPropertyExpressionValueSourceRuntime
 Runtime for object property expression value source. More...
 
class  ObjectPropertyListenerImpl
 Object property listener implementation. More...
 
class  ObjectSource
 Structure for object source. More...
 
class  ObjectSourceRuntime
 Runtime for an object source. More...
 
class  ObjectTypeFilter
 Use the Object Type Filter to collect 3D nodes based on their type. More...
 
class  ObjectTypeFilterRuntime
 Runtime for object type filter. More...
 
class  OnAttachedTrigger
 On Attached Trigger. More...
 
class  OnPropertyChangedTrigger
 Invokes associated actions on setting of a property type, specified by SourcePropertyTypeProperty, on a source node, specified by SourceNodeProperty. More...
 
class  OrientationChangedEvent
 Specialized event that reports the orientation change of a window. More...
 
class  OrientedBoundingBox
 An oriented bounding box represents a bounding box that has been transformed by a transformation matrix. More...
 
class  OutlineEffect2D
 Use OutlineEffect2D to apply an outline to the content of 2D nodes. More...
 
class  OutlineEffectRenderer2D
 Outline effect renderer class. More...
 
class  OverlayScope
 Implements the base of overlay focus scopes. More...
 
class  Page
 Use Page nodes to create the structure of an application user interface. More...
 
class  PageHost
 Use a PageHost node to group Page and PageHost nodes, and to manage navigation requests and transitions in a tree of Page nodes under a PageHost node. More...
 
class  PageTransitionCollection
 Transition collection is used to define transitions within a Page Host. More...
 
class  PanManipulator
 Pan input manipulator recognizes a pan gesture from the incoming touch events. More...
 
class  PanManipulatorComponent
 PanManipulatorComponent installs a PanManipulator to a node. More...
 
class  ParallelActivityHost2D
 An Activity Host that can display multiple Activity nodes at a time. More...
 
class  ParallelActivityHost3D
 An Activity Host that can display multiple Activity nodes at a time. More...
 
class  ParallelActivityHostConcept
 This is the base class for Parallel Activity Host nodes. More...
 
struct  ParallelActivityHostContentHandler
 Helper class used to modify the ParallelActivityHostContent of a ParallelActivityHost. More...
 
class  ParallelActivityHostImpl
 ParallelActivityHostConcept implementation class. More...
 
class  ParallelTimeline
 Kanzi animation system consists of animations and timelines: More...
 
class  ParallelTimelinePlayback
 Playback control class for parallel timelines. More...
 
class  PatchingNotificationHandler
 Patching notification handler interface. More...
 
class  PerformanceInfo
 HUD class allows drawing information on top of tests. More...
 
struct  PerformanceInfoProperties
 Configurable performance info display properties. More...
 
class  PinchManipulator
 Pinch input manipulator recognizes the pinch gesture from the incoming touch events. More...
 
class  PipelineStateRenderPass
 Use the Pipeline State Render Pass to set for its child render passes the depth and stencil testing, transparency, and culling. More...
 
class  Plane
 The equation of a plane in 3D space is defined with a normal vector (perpendicular to that plane) and a known point on the plane. More...
 
struct  PlanePlaneIntersection
 Stores the intersection of two planes. More...
 
struct  PlaneRayIntersection
 Stores the result of an intersection between a plane and a ray. More...
 
class  Plugin
 
class  PointerEvent
 The event holds a pointer event data and typically originates from a mouse or other pointing device. More...
 
class  Portal
 Portal node. More...
 
class  PosixDynamicLibrary
 POSIX dynamic library. More...
 
struct  PowerEasingFunction
 Changes the value with a configurable power function using the function f(t) = t^p, where p is equal to the power parameter. More...
 
class  PrefabTemplate
 A prefab template contains information that is required to create a tree of Node instances. More...
 
class  PrefabTemplateNode
 A prefab template node contains information that is required to create node instances: the metaclass of the node, the (initial) property values of the node, information about the bindings and node components of the node, and the list of of child nodes. More...
 
class  PrefabView2D
 Prefab view 2D node. More...
 
class  PrefabView3D
 Prefab view 3D node. More...
 
class  PrefabViewConcept
 Prefab view concept class. More...
 
class  PrefabViewConceptImpl
 Base class for prefab views. More...
 
class  PreviewTimeline
 Preview timeline,. More...
 
class  PreviewTimelinePlayback
 Preview timeline playback controls child timeline playbacks based on preview instructions. More...
 
class  ProfilerRegistry
 Profiler registry. More...
 
class  ProfilingCategory
 Represents the runtime state of the profiling category. More...
 
class  ProfilingScopeHelper
 The profiling scope helper. More...
 
class  ProgressiveRenderingViewport2D
 Progressive rendering viewport 2D is a viewport which splits rendering its scene across multiple frames. More...
 
class  PropertyAccessRange
 Property access range wraps the access of properties from another range. More...
 
class  PropertyAnimationTimeline
 The Kanzi animation system consists of animations, which define how to animate properties, and timelines, which map animations to time and to the objects that you want to animate. More...
 
class  PropertyAnimationTimelinePlayback
 Playback class for PropertyAnimationTimeline. More...
 
struct  PropertyDataTypeTraits
 
struct  PropertyDataTypeTraits< AbstractRangeSharedPtr >
 
struct  PropertyDataTypeTraits< bool >
 
struct  PropertyDataTypeTraits< ColorRGBA >
 
struct  PropertyDataTypeTraits< float >
 
struct  PropertyDataTypeTraits< int >
 
struct  PropertyDataTypeTraits< Matrix3x3 >
 
struct  PropertyDataTypeTraits< Matrix4x4 >
 
struct  PropertyDataTypeTraits< ResourceSharedPtr >
 
struct  PropertyDataTypeTraits< SRTValue2D >
 
struct  PropertyDataTypeTraits< SRTValue3D >
 
struct  PropertyDataTypeTraits< string >
 
struct  PropertyDataTypeTraits< Vector2 >
 
struct  PropertyDataTypeTraits< Vector3 >
 
struct  PropertyDataTypeTraits< Vector4 >
 
struct  PropertyDataTypeTraits< void * >
 
class  PropertyDrivenAnimationPlayer
 Use Property Driven Animation Player when you want to use a property type to control a keyframe animation. More...
 
class  PropertyFieldAnimationTimeline
 Kanzi animation system consists of animations and timelines: More...
 
class  PropertyFieldAnimationTimelinePlayback
 Playback control class for Property Field Animation timelines. More...
 
class  PropertyFieldTargetInterpolationTimelinePlayback
 Playback for property target interpolation timeline for interpolating specific property field. More...
 
class  PropertyIsEqualFilter
 Use the Property Is Equal Filter to collect 3D nodes that contain, or do not contain a specific property whose value matches a specific value. More...
 
class  PropertyIsEqualFilterRuntime
 Runtime for contains property node filter. More...
 
class  PropertyListener
 
class  PropertyModifierBindingTargetRuntime
 Base class for property modifier binding target runtimes. More...
 
class  PropertyObject
 PropertyObject is the base class that supports setting and retrieving of property types. More...
 
class  PropertyObserver
 Helper class for observing certain property in nodes. More...
 
class  PropertyTargetEasingInterpolator
 Use a Property Target Easing Interpolator when you want to create a smooth transition between the current value of a property and a value that you set dynamically. More...
 
class  PropertyTargetEasingTimeline
 Property Target Easing Timeline interpolates a property gradually from its old value to a new value using an easing curve each time a new value is set to the property. More...
 
class  PropertyTargetEasingTimelinePlayback
 Playback for PropertyTargetEasingTimeline. More...
 
class  PropertyTargetInterpolationTimeline
 Property target interpolation timeline is a timeline that gradually interpolates specified property from its old value to new one each time new value is set to the property. More...
 
class  PropertyTargetInterpolationTimelinePlayback
 Playback for property target interpolation timeline. More...
 
class  PropertyTargetInterpolator
 Use a Property Target Interpolator when you want to dynamically set the target value of a property and want to interpolate the current value to the target value over time. More...
 
class  PropertyType
 An instance of a PropertyType represents a single property type in the Kanzi property system. More...
 
class  PropertyType< Type, typename enable_if< is_enum< Type >::value >::type >
 Specialization for PropertyType for enums. See PropertyType. More...
 
class  PropertyTypeDescriptor
 PropertyTypeDescriptor is used internally by the property system to implement all operations required for property types that have the same data type. More...
 
struct  PropertyTypeEditorInfo
 Editor information for metadata. More...
 
class  QnxLogger
 
class  QuadDescription
 Use QuadDescription to create renderable quad geometry. More...
 
struct  QuadraticEasingFunction
 Changes the value based on the square of time using the function f(t) = t^2. More...
 
struct  QuarticEasingFunction
 Changes the value based on the 4th order polynomial using the function f(t) = t^4. More...
 
class  Quaternion
 Quaternions represent rotation around an axis, defined by quaternion components x, y, z and w. More...
 
struct  QuaternionLongerPath
 Quaternion for interpolating rotation along longer path. More...
 
struct  QuinticEasingFunction
 Changes the value based on the 5th order polynomial using the function f(t) = t^5. More...
 
class  RangeAccumulateBindingProcessor
 Runs a binary operation for each value in a range in sequence. More...
 
class  RangeAccumulateBindingProcessorRuntime
 Holds the runtime state of a RangeAccumulateBindingProcessor. More...
 
class  RangeBindingProcessor
 Range binding processor is a binding processor for accessing properties from property objects in ranges. More...
 
class  RangeBindingProcessorRuntime
 Holds the runtime state of a RangeBindingProcessor. More...
 
class  RangeConcept
 RangeConcept represents a number range with an optional step. More...
 
class  RangeConceptImpl
 
class  Ray
 Ray can be mathematically defined as a point (the origin of the ray in space) and a direction. More...
 
struct  RayBoxIntersection
 Stores the result of an intersection between a box and a ray. More...
 
class  ReadOnlyDiskFile
 Implements the File interface for files residing on a disk. More...
 
class  ReadOnlyMemoryFile
 The ReadOnlyMemoryFile class provides a (read-only) file interface to a block of memory. More...
 
class  Rectangle
 2-dimensional integer rectangle. More...
 
class  ReferenceCountScopeGuard
 Reference count scope guard. More...
 
class  RelativeNodeResolver
 Enables you to get the current node in relative path. More...
 
class  Renderbuffer
 Renderbuffers provide the images that can be rendered to by attaching them to the framebuffer as color or depth stencil images. More...
 
class  RenderEntry3D
 Host container for render states for 3D rendering. More...
 
class  RenderEntryRegistry
 Registry used to keep track of DrawObjectsRenderPass objects that contain render entries. More...
 
class  Renderer
 
class  Renderer3D
 Renderer is the core component for assigning lights, meshes, cameras, skin animations etc. to lower level rendering. More...
 
class  RendererStatisticsScope
 
class  RenderPass
 RenderPass is the base class for Kanzi render passes. More...
 
class  RenderPassPrefab
 Use render pass prefabs to create render pass trees that define how Kanzi renders 3D content in your project. More...
 
class  RenderPassTemplate
 Use RenderPassTemplate to instantiate a single render pass. More...
 
class  RenderPassView
 Use the Render Pass View to instantiate a RenderPassPrefab. More...
 
class  RenderPropertyBindingSource
 Render property binding source. More...
 
class  RenderPropertyBindingSourceRuntime
 Runtime for RenderPropertyBindingSource. More...
 
class  RenderPropertyExpressionValueSource
 Render property expression value source. More...
 
class  RenderPropertyExpressionValueSourceRuntime
 Runtime for render property expression value source. More...
 
class  RenderStatePropertyNotificationHandler
 Render value updater for render state. More...
 
class  RenderValueBindingTargetRuntime
 Runtime for render value binding target. More...
 
class  Resource
 Represents the base class for all resources. More...
 
class  ResourceBindingProcessor
 Resource binding processor creates a resource reference that is used to resolve a string into a resource. More...
 
class  ResourceBindingProcessorRuntime
 Holds the runtime state of a ResourceBindingProcessor. More...
 
class  ResourceBindingSource
 Resource binding source. More...
 
class  ResourceBindingSourceRuntime
 Runtime for object property binding source. More...
 
class  ResourceDictionary
 A resource dictionary is a container that maps resource IDs to resources. More...
 
class  ResourceDictionarySelector
 A resource dictionary selector is a type of a resource dictionary that redirects resource queries to its only nested dictionary. More...
 
class  ResourceID
 Resource ID. More...
 
class  ResourceLoaderFactory
 Factory for resource loader tasks. More...
 
struct  ResourceLoaderThreadContext
 Resource loader thread local data. More...
 
class  ResourceManager
 Use the resource manager to access and use resources in kzb files. More...
 
class  ResourceProfiler
 The resource profiler. More...
 
class  ResourceProfilingAcquireContext
 The profiling context of resource acquirement. More...
 
class  ResourceProfilingAttributes
 Container for resource profiling attributes. More...
 
class  ResourceProfilingContext
 The resource profiling context. More...
 
class  ResourceProfilingContextFactory
 Resource profiling context factory. More...
 
class  ResourceProfilingDataSample
 The resource profiling data sample. More...
 
class  ResourceProfilingDeployContext
 The profiling context of resource deployment. More...
 
class  ResourceProfilingLoadContext
 The profiling context of resource loading. More...
 
class  ResourceProfilingLoadTask
 Resource profiling wrapper for load task. More...
 
class  ResourceProfilingMainLoopContext
 The main loop resource profiling context. More...
 
struct  ResourceProfilingPtreePopulator
 Resource profiling ptree populator. More...
 
class  ResourceReference
 
class  Sampler
 Sampler provides the sampling parameters, such as minification and magnification filters, mipmap mode, and texture addressing mode for textures. More...
 
class  Scene
 Scene is a 3D node that is the root node for other 3D nodes. More...
 
class  SceneGraphTimelinePlaybackContext
 Helper class to resolve objects for animation timelines. More...
 
class  ScopedRefCounter
 Scoped reference counter, which takes an unsigned integer value as argument on construction to track. More...
 
class  ScopeValue
 ScopeValue template class sets a value to a variable of Type for the lifetime of the ScopeValue object, and restores the previous value of the variable when destroyed. More...
 
class  Screen
 The screen represents the metrics of the target device and acts as the root node for the whole node tree. More...
 
class  ScrollView2D
 Use the Scroll View 2D node to create an input plane to enable user input from gestures. More...
 
class  ScrollView3D
 Use the Scroll View 3D node to create an input plane to enable user input from gestures. More...
 
class  ScrollViewConcept
 ScrollViewConcept is the base class that provides the functionality for the ScrollView2D and ScrollView3D classes. More...
 
class  ScrollViewConceptImpl
 Implementation class for ScrollViewConcept. More...
 
class  SetPropertyAction
 SetPropertyAction sets the value of a property of a target node based on: More...
 
class  ShaderProgram
 ShaderProgram defines programmable vertex and fragment operations done by the GPU for a draw call. More...
 
struct  ShaderTextureUniform
 Specifies single texture uniform entry. More...
 
class  ShaderVertexAttribute
 ShaderVertexAttribute describes the attributes that shader program will read when executed by graphics device. More...
 
class  ShadowEffect2D
 Use ShadowEffect2D to apply drop- and inner-shadow post-processing effects to 2D nodes. More...
 
class  ShadowEffectRenderer2D
 Shadow effect renderer class. More...
 
class  SharedImmutableString
 Shared immutable string container. More...
 
struct  SineEasingFunction
 Changes the value with a sine formula. More...
 
class  Slider2D
 Use the Slider 2D node as a building block for a 2D UI control that lets the application user change a numerical value using a visual indicator between a minimum and a maximum value. More...
 
class  Slider2DConceptImpl
 
class  Slider3D
 Use the Slider 3D node as a building block for a 3D UI control that lets the application user change a numerical value using a visual indicator between a minimum and a maximum value. More...
 
class  Slider3DConceptImpl
 
class  SliderConcept
 SliderConcept contains the trajectory ResourceID property. More...
 
class  SliderTrajectoryPresenter
 
struct  SmootherStepEasingFunction
 Changes the value quickly without instant changes in velocity. More...
 
struct  SmoothStepEasingFunction
 Changes the value quickly without instant changes in velocity. More...
 
class  SortByShaderObjectSource
 Sort by shader object source. More...
 
class  SortByShaderObjectSourceRuntime
 Runtime for sort by shader object source. More...
 
class  SortByZObjectSource
 Z-sorting object source. More...
 
class  SortByZObjectSourceRuntime
 Runtime for z-sort object source. More...
 
class  SortObjectSource
 Sort object source. More...
 
class  SortObjectSourceRuntime
 Base class for sort runtime classes. More...
 
class  span
 
class  SpeedMeasurer
 Speed measurer estimates the rate of change from a series of measurements. More...
 
class  Spline
 Spline is a piecewise polynomial curve that defines a path in a 3-dimensional space. More...
 
class  SplitStringRange
 SplitStringRange is a range that iteratively performs a string split. More...
 
class  SRTValue2D
 A structure that describes the scale, rotation and translation transformation in 2D space. More...
 
class  SRTValue3D
 A structure that describes the scale, rotation and translation transformation in 3D space. More...
 
class  SRTValue3DLongerPath
 
class  StackLayout2D
 Stack Layout 2D arranges its items on a line along the axis you specify in the DirectionProperty. More...
 
class  StackLayout3D
 Stack Layout 3D arranges its items on a line along the axis you specify in the DirectionProperty. More...
 
class  StackLayoutConcept
 Stack layout concept base class. More...
 
class  StackLayoutConceptImpl
 Stack layout concept implementation base class. More...
 
struct  Stage
 Stage instances represent a Stage in the Kanzi main loop. More...
 
class  StandardMaterial
 Contains property types of Standard material. More...
 
class  StandardPbrMaterial
 Contains property types for the Kanzi Physically Based Rendering (PBR) shaders. More...
 
class  StartupProfilerRegistry
 The registry of startup profilers. More...
 
class  StateManager
 State manager for managing states of nodes or application. More...
 
struct  StepEasingFunction
 Changes the value instantly. More...
 
class  StopWatch
 Stop watch is a class for measuring time. More...
 
class  Style
 Style applying properties, node components and bindings to nodes. More...
 
class  Surface
 Surfaces provide images for Framebuffers where to render to. More...
 
class  Tag
 Tag represents a mark that can be added to a node to mark that the node is of certain kind. More...
 
class  TagFilter
 Use the Tag Filter to collect 3D nodes that have a specific tag assigned. More...
 
class  TagFilterRuntime
 Runtime for tag filter. More...
 
class  TargetPreviewPlugin
 Target preview plugin allows Kanzi Studio to remotely apply UI scene changes to the application. More...
 
class  TaskDispatcher
 Task dispatcher. More...
 
class  TaskDispatcherBase
 Base class for TaskDispatcher implementation. More...
 
class  TextBlock2D
 Text Block 2D displays a small amount of text in 2D. More...
 
class  TextBlock3D
 Text Block 3D displays a small amount of text in 3D. More...
 
class  TextBlockConcept
 Base class for the Text Block nodes that you can use to show a small amount of text in your application. More...
 
class  TextBlockConceptImpl
 Implementation class for TextBlockConcept. More...
 
class  TextBox2D
 TextBox2D provides the required overrides to handle 2D rendering and gesture handling for the 2D text input. More...
 
struct  TextBox2DTraits
 
class  TextBox3D
 TextBox3D provides the required overrides to handle 3D rendering and gesture handling for the 3D text input. More...
 
struct  TextBox3DTraits
 
class  TextBoxConcept
 Use the Text Box nodes to add single-line text input to your application. More...
 
class  TextBoxConceptImpl
 TextBoxConceptImpl is an abstract class for implementing the Text Box node concept. More...
 
class  TextBreakIterator
 
class  TextConcept
 TextConcept is the base class for the nodes that implement text rendering. More...
 
class  TextConceptImpl
 TextConceptImpl provides the common base implementation for text rendering nodes. More...
 
class  TextEditBuffer
 TextEditBuffer is a model for text input. More...
 
class  TextFormat
 Text format combines the data required for text layouting and the data required for rendering the text. More...
 
struct  TextInputGesture
 The text input key gesture. More...
 
class  TextInputLayout
 Use TextInputLayout to precalculate information on text layout properties, such as glyph directionality, width, buffer index to glyph mapping, and so on. More...
 
class  TextInputManipulator
 The text input manipulator handles key gestures used with TextBox nodes to move the cursor, select text, and delete text, and provides the basics of text editing capabilities in Kanzi. More...
 
struct  TextLayout
 Structure for layout of arbitrary number of characters for text rendering. More...
 
class  TextLayouter
 Use the TextLayouter to create layouts for display text strings, including line breaks, bidirectional text shaping, and similar. More...
 
class  TextManager
 Use the TextManager class to: More...
 
class  TextResource
 Text resource. More...
 
class  TextShaper
 TextShaper encapsulates different shaping libraries, used by TextLayouter to perform BiDi layouting, text shaping and glyph substitution. More...
 
class  Texture
 Textures provide images that can be used with image nodes, texture brushes and materials for use in 3D rendering or material brushes. More...
 
class  TextureBrush
 Texture brush class. More...
 
class  TextureBrushRenderer
 Texture brush renderer class. More...
 
class  TextureSwizzleMask
 Use the texture swizzle mask to reorder the color channel values returned by the texture function in a shader. More...
 
struct  TimeInterval
 Interval in time specified as start and end timestamps. More...
 
class  Timeline
 The Kanzi animation system consists of animations and timelines: animations define how the values of specific type change in time, and timelines map the animations to properties of objects you want to animate. More...
 
class  TimelineClock
 Use TimelineClock to update a Timeline based on time. More...
 
class  TimelinePlayback
 Playback object for Timelines. More...
 
class  TimelinePlaybackContext
 Use TimelinePlaybackContext helper interface class to defines the context of an animation playback. More...
 
class  TimelineResource
 A Resource wrapper class for animation timelines. More...
 
class  TimerTrigger
 Use the TimerTrigger to execute actions at the time interval that you set with the IntervalProperty. More...
 
class  ToggleButton2D
 Use the Toggle Button 2D node to create a 2D UI control that the user can interact with through clicking, tapping, or pressing a keyboard key, and that has multiple toggle states. More...
 
class  ToggleButton3D
 Use the Toggle Button 3D node to create a 3D UI control that the user can interact with through clicking, tapping, or pressing a keyboard key, and that has multiple toggle states. More...
 
class  ToggleButtonGroup2D
 Toggle Button Group 2D allows users of your application to select only one option from a set of options that are mutually exclusive. More...
 
class  ToggleButtonGroup3D
 Toggle Button Group 3D allows users of your application to select only one option from a set of options that are mutually exclusive. More...
 
class  ToggleButtonGroupConcept
 Use a Toggle Button Group to control a collection of Toggle Buttons so that only one Toggle Button can be toggled on at a time. More...
 
class  ToggleButtonGroupConceptImpl
 Implementation class for ToggleButtonGroupConcept. More...
 
class  ToSourceBinding
 To Source bindings are one-way bindings that have an extra source to which to write the result value. More...
 
class  ToSourceBindingRuntime
 Runtime for ToSourceBinding. More...
 
class  TouchEvent
 The event holds the information about a touch event occurrence. More...
 
struct  TouchPoint
 The structure describes the attributes for a touch point or mouse hit. More...
 
struct  TouchPointIdEquals
 Helper predicate functor which you can use to search for a touch point within a touch point container using the identifier of a touch point. More...
 
struct  TouchPointStateEquals
 Helper predicate functor which you can use to search within a touch point container using the state of a touch point. More...
 
class  Trajectory
 Trajectory defines a series of points following a geometrical path. More...
 
class  Trajectory2DInputHandler
 
class  Trajectory2DInputLogic
 
class  Trajectory3DInputHandler
 
class  Trajectory3DInputLogic
 
class  TrajectoryLayout2D
 Trajectory Layout 2D arranges its items along a trajectory. More...
 
class  TrajectoryLayout3D
 Trajectory Layout 3D arranges its items along a trajectory. More...
 
class  TrajectoryLayoutConcept
 Base class for TrajectoryLayout classes. More...
 
class  TrajectoryLayoutConceptImpl
 TrajectoryLayoutConceptImpl provides the common base implementation for Trajectory Layout nodes. More...
 
class  TrajectoryListBox3D
 Use the Trajectory List Box 3D node to create scrollable lists of items arranged along a Trajectory. More...
 
class  TrajectoryListBox3DTraits
 
class  Trigger
 Trigger is the base class for defining events, conditions and actions for content-driven logic programming. More...
 
class  TriggerTemplate
 TriggerTemplate is the base class for trigger templates. More...
 
class  TrySetFocusAction
 Use the TrySetFocusAction action to transfer focus to any focusable item in a node tree. More...
 
class  TwoWayBinding
 Two-way binding causes changes to either the source value or the target value to automatically update the other. More...
 
class  TwoWayBindingRuntime
 Runtime for two-way binding. More...
 
class  TypedManualBindingSourceRuntime
 Typed runtime for manual binding source. More...
 
class  TypedManualBindingTargetRuntime
 Typed runtime for manual binding target. More...
 
class  TypedMessageBindingSourceRuntime
 Runtime for message binding source. More...
 
class  TypedMessageBindingTargetRuntime
 Typed runtime for message binding target. More...
 
class  TypedObjectPropertyBindingSourceRuntime
 Runtime for object property binding source. More...
 
class  TypedObjectPropertyExpressionValueSourceRuntime
 Typed runtime for object property expression value source. More...
 
class  TypedPropertyModifierBindingTargetRuntime
 Specialized binding target for property modifiers installed to objects. More...
 
class  TypedRenderPropertyBindingSourceRuntime
 Runtime for render property binding source. More...
 
class  TypedRenderPropertyExpressionValueSourceRuntime
 Typed runtime for render property expression value source. More...
 
class  TypedRenderStatePropertyNotificationHandler
 Specialized property notification handler for render state. More...
 
class  TypedRenderStateRangePropertyNotificationHandler
 Specialized notification handler for render state. More...
 
class  TypedRenderValueBindingTargetRuntime
 Typed runtime for render value binding target. More...
 
class  TypedValueRange
 TypedValueRange is a template class for holding one type of object in a range. More...
 
class  TypedValueSourceBindingTargetRuntime
 Specialized binding target for value sources where the binding target itself is the value source. More...
 
class  TypedVariableBindingSourceRuntime
 Typed runtime for variable binding source. More...
 
class  TypedVariableBindingTargetRuntime
 Typed runtime for variable binding target. More...
 
class  TypedVariableExpressionValueSourceRuntime
 Typed runtime for variable expression value source. More...
 
class  UnableToOpenFileException
 Kanzi throws this exception when it tries to load a file that cannot be opened or does not exist. More...
 
class  UsingIntrusivePtr
 Class that should be inherited by objects using intrusive_ptr. More...
 
class  ValueAccumulatorBase
 ValueAccumulatorBase is the base class for the Value Accumulator implementations for different data types. More...
 
class  ValueAccumulatorTimeline
 Use ValueAccumulatorTimeline to create an animation that continuously adds the value of the input property to the target property. More...
 
class  ValueAccumulatorTimelinePlayback
 Playback for ValueAccumulatorTimeline. More...
 
class  ValueAnimation
 Interface template for value animations. More...
 
class  ValueBindingSource
 Constant value as binding source. More...
 
class  ValueBindingSourceRuntime
 Runtime for ValueBindingSource. More...
 
class  ValueControlledExclusiveActivityHostConcept
 Base class for the Exclusive Activity Host classes. More...
 
class  ValueRange
 ValueRange is an abstract range implementation that stores variant values. More...
 
class  ValueSourceBindingTargetRuntime
 Base class for value source binding target runtimes. More...
 
class  VariableBindingHost
 Binding variable host. More...
 
class  VariableBindingSource
 Variable binding source. More...
 
class  VariableBindingSourceRuntime
 Runtime for variable binding source. More...
 
class  VariableBindingTargetRuntime
 Variable binding target runtime. More...
 
class  VariableExpressionValueSource
 Variable expression value source. More...
 
class  VariableExpressionValueSourceRuntime
 Runtime for variable expression value source. More...
 
struct  Variant
 Union container for manipulating an object from a heterogeneous set of types in a uniform manner. More...
 
class  Vector2
 Vector with 2 floating point components: (x, y). More...
 
class  Vector3
 Vector with 3 floating point components: (x, y, z). More...
 
class  Vector4
 Vector with 4 floating point components: (x, y, z, w). More...
 
class  VertexAttribute
 Base class for the vertex and instance attributes of mesh and shader program. More...
 
class  Viewport2D
 Use a Viewport 2D to set the size of a render target surface onto which content is projected. More...
 
class  Viewport3D
 Use the Viewport 3D node to render 2D nodes in 3D space. More...
 
class  ViewRange
 View over another range. More...
 
class  ViewRangeImpl
 View range internal implementation class. More...
 
class  VisitorFunction
 Wraps a focus scope visitor function into a FocusScopeVisitor. More...
 
class  VulkanGraphicsOutput
 VulkanGraphicsOutput class. More...
 
class  Watermark
 Watermark. More...
 
class  Win32DebugLogger
 This logger class writes log messages to the Windows debugger console. More...
 
class  WindowedGraphicsOutput
 WindowedGraphicsOutput class. More...
 
class  WindowEvent
 The WindowEvent class holds window specific events. More...
 
class  WindowPlacementRequestEvent
 Specialized window event with InputEvent::WindowPlacementRequest type. More...
 
class  WindowRedrawRequestEvent
 Specialized window event with InputEvent::WindowRedrawRequest type. More...
 
class  WindowResizedEvent
 Specialized window event with InputEvent::WindowResized type. More...
 
class  WindowResizeRequestEvent
 Specialized window event with InputEvent::WindowResizeRequest type. More...
 
class  WindowsIme
 
class  WindowsImeBackend
 
class  WriteLogAction
 Use the WriteLogAction class to attach logging functionality to a trigger. More...
 
class  WriteOnlyDiskFile
 Implements the File interface for writing files to a disk. More...
 

Typedefs

using AbstractAnimationSharedPtr
 
using AbstractBindingRuntimeSharedPtr
 AbstractBindingRuntime shared pointer type.
 
using AbstractBindingRuntimeWeakPtr
 AbstractBindingRuntime weak pointer type.
 
using AbstractBindingSharedPtr
 Abstract binding shared pointer type.
 
typedef unique_ptr< AbstractExpressionValueSourceRuntimeAbstractExpressionValueSourceRuntimePtr
 Abstract expression value source unique pointer type.
 
typedef shared_ptr< AbstractExpressionValueSourceAbstractExpressionValueSourceSharedPtr
 Abstract expression value source shared pointer type.
 
using AbstractIndexedRangeSharedPtr
 AbstractIndexedRange shared pointer type.
 
typedef unique_ptr< AbstractLoggerAbstractLoggerUniquePtr
 Typedef of the kanzi::AbstractLogger unique pointer.
 
typedef ProfilerRegistry< AbstractProfilerAbstractProfilerRegistry
 AbstractProfilerRegistry declaration.
 
typedef shared_ptr< AbstractProfilerAbstractProfilerSharedPtr
 The shared pointer to the abstract profiler source.
 
typedef shared_ptr< AbstractPropertyNotificationHandlerAbstractPropertyNotificationHandlerSharedPtr
 Abstract property notification handler shared pointer.
 
using AbstractRangeLocationPtr
 AbstractRangeLocation unique pointer type.
 
using AbstractRangeSharedPtr
 Abstract range shared pointer type.
 
using AbstractRangeWeakPtr
 Abstract range weak pointer type.
 
using ActionBaseSharedPtr
 
using ActionBaseWeakPtr
 
using ActionConstIterator
 
using ActionContainer
 
using ActionSharedPtr
 
using ActionWeakPtr
 
typedef shared_ptr< Activity2DActivity2DSharedPtr
 Activity2D shared pointer.
 
typedef shared_ptr< Activity3DActivity3DSharedPtr
 Activity3D shared pointer.
 
using ActivityBrowserControllerSharedPtr
 ActivityBrowserController shared pointer.
 
using ActivityCodeBehindSharedPtr
 ActivityCodeBehind shared pointer.
 
using ActivityElementSharedPtr
 
using AnimationBindingProcessorRuntimePtr
 AnimationBindingProcessorRuntime unique pointer type.
 
using AnimationBindingProcessorSharedPtr
 Animation binding processor shared pointer type.
 
typedef shared_ptr< AnimationPlayerAnimationPlayerSharedPtr
 
typedef shared_ptr< AnimationResourceAnimationResourceSharedPtr
 
typedef shared_ptr< AppliedStyleEntryAppliedStyleEntrySharedPtr
 AppliedStyleEntry shared pointer type.
 
using ApplyActionSharedPtr
 
using ApplyActivationActionSharedPtr
 
using ApplyPropertyActionSharedPtr
 
typedef map< string, intAttributeNameToIndex
 
typedef AttributeNameToIndex::const_iterator AttributeNameToIndexConstIterator
 
typedef AttributeNameToIndex::iterator AttributeNameToIndexIterator
 
using BinaryResourceSharedPtr
 
typedef shared_ptr< BindingBaseBindingBaseSharedPtr
 
typedef bool(* BindingExpressionFunction) (BindingExpressionOpCodeParameters &params)
 Expression function pointer type.
 
using BindingHostConceptSharedPtr
 
using BindingHostConceptWeakPtr
 
using BindingLookupContextPtr
 BindingLookupContext unique pointer type.
 
using BindingProcessorRuntimePtr
 BindingProcessorRuntime unique pointer type.
 
using BindingProcessorSharedPtr
 BindingProcessor shared pointer type.
 
typedef shared_ptr< BindingRuntimeBindingRuntimeSharedPtr
 BindingRuntime shared pointer type.
 
typedef shared_ptr< BindingBindingSharedPtr
 Binding shared pointer type.
 
typedef unique_ptr< BindingSourceBindingSourcePtr
 Binding source unique pointer type.
 
using BindingSourceRuntimePtr
 Binding source runtime pointer type.
 
using BindingTargetRuntimePtr
 Binding target runtime unique pointer type.
 
using BindingTokenSharedPtr
 
using BindingTokenUniquePtr
 
using BindingTokenWeakPtr
 
using BitmapFontLoaderPtr
 
typedef shared_ptr< BitmapImageBitmapImageSharedPtr
 Image shared pointer type.
 
typedef unique_ptr< BitmapImageBitmapImageUniquePtr
 Image unique pointer type.
 
typedef vector< BitmapImageUniquePtrBitmapImageVector
 Image shared pointer vector type.
 
typedef shared_ptr< BlitRenderPassBlitRenderPassSharedPtr
 BlitRenderPass shared pointer type.
 
using BlurEffect2DSharedPtr
 Blur effect shared pointer type.
 
using BlurEffectRenderer2DUniquePtr
 Blur effect renderer unique pointer type.
 
using BoolAnimation
 
using BoolAnimationSharedPtr
 
typedef KeyframeAnimation< boolBoolKeyframeAnimation
 
typedef shared_ptr< BoolKeyframeAnimationBoolKeyframeAnimationSharedPtr
 
typedef FromToAnimation< bool, LinearEasingFunctionBoolLinearFromToAnimation
 
typedef shared_ptr< BoolLinearFromToAnimationBoolLinearFromToAnimationSharedPtr
 
using BrushRendererPtr
 Brush renderer unique pointer.
 
using BrushSharedPtr
 Brush shared pointer.
 
typedef shared_ptr< BufferObjectStreamBufferObjectStreamSharedPtr
 
using Button2DSharedPtr
 
using Button3DSharedPtr
 
typedef unsigned char byte
 
using ByteSpan
 ByteSpan refers to contiguous sequence of bytes.
 
using CallbackBindingProcessorSharedPtr
 CallbackBindingProcessor shared pointer type.
 
using CallbackProcessorRuntimePtr
 CallbackProcessorRuntime unique pointer type.
 
using CameraSharedPtr
 CameraNode shared pointer.
 
using CameraWeakPtr
 CameraNode weak pointer.
 
typedef shared_ptr< ClearRenderPassClearRenderPassSharedPtr
 ClearRenderPass shared pointer type.
 
using ClickManipulatorComponentSharedPtr
 
using ClickManipulatorSharedPtr
 
typedef shared_ptr< CodeBehindRegisterGuardCodeBehindRegisterGuardSharedPtr
 CodeBehindRegisterGuard shared pointer.
 
using CodeBehindSharedPtr
 CodeBehind shared pointer.
 
typedef shared_ptr< ColorBrushColorBrushSharedPtr
 
using ColorRGBAAnimation
 
using ColorRGBAAnimationSharedPtr
 
typedef KeyframeAnimation< ColorRGBAColorRGBAKeyframeAnimation
 
typedef shared_ptr< ColorRGBAKeyframeAnimationColorRGBAKeyframeAnimationSharedPtr
 
typedef FromToAnimation< ColorRGBA, LinearEasingFunctionColorRGBALinearFromToAnimation
 
typedef shared_ptr< ColorRGBALinearFromToAnimationColorRGBALinearFromToAnimationSharedPtr
 
using CombinerObjectSourceRuntimeSharedPtr
 Combiner object source runtime shared pointer type.
 
using CombinerObjectSourceSharedPtr
 Combiner object source shared pointer type.
 
typedef shared_ptr< CompositionBrushCompositionBrushSharedPtr
 Shared pointer type.
 
typedef unique_ptr< CompositionStackCompositionStackPtr
 Composition stack shared pointer.
 
typedef shared_ptr< CompositionTargetRenderPassCompositionTargetRenderPassSharedPtr
 CompositionTargetRenderPass shared pointer type.
 
template<bool B, typename T , typename F >
using conditional_t
 
using ConditionConstIterator
 
using ConditionContainer
 
using ConditionSharedPtr
 
using ConstByteSpan
 ConstByteSpan refers to constant contiguous sequence of bytes.
 
using ConstCharArrayUniquePtr
 Alias for a unique_ptr to array of const char.
 
using ContainsPropertyFilterRuntimeSharedPtr
 Contains property node filter runtime shared pointer type.
 
typedef shared_ptr< ContainsPropertyFilterContainsPropertyFilterSharedPtr
 Contains Property Filter shared pointer type.
 
typedef shared_ptr< ContentBrushContentBrushSharedPtr
 Shared pointer type.
 
using ContentLayout2DSharedPtr
 
using ContentLayout3DSharedPtr
 
using CubeMapRenderPassSharedPtr
 CubeMapRenderPass shared pointer type.
 
typedef unique_ptr< CurveReparametrizationCurveReparametrizationPtr
 CurveReparametrization unique pointer type.
 
typedef shared_ptr< DataContextDataContextSharedPtr
 
typedef shared_ptr< DataDrivenExclusiveActivityHost2DDataDrivenExclusiveActivityHost2DSharedPtr
 DataDrivenExclusiveActivityHost2D shared pointer.
 
typedef shared_ptr< DataDrivenExclusiveActivityHost3DDataDrivenExclusiveActivityHost3DSharedPtr
 DataDrivenExclusiveActivityHost3D shared pointer.
 
using DataObjectBoolSharedPtr
 
typedef shared_ptr< DataObjectEnumBaseDataObjectEnumBaseSharedPtr
 
using DataObjectIntSharedPtr
 
typedef shared_ptr< DataObjectListDataObjectListSharedPtr
 
using DataObjectRealSharedPtr
 
using DataObjectSharedPtr
 DataObject shared pointer type.
 
using DataObjectStringSharedPtr
 
using DataObjectWeakPtr
 DataObject weak pointer type.
 
typedef shared_ptr< DataSourceExpressionValueSourceDataSourceExpressionValueSourceSharedPtr
 DataSourceExpressionValueSource shared pointer type.
 
typedef shared_ptr< DataSourceListItemGenerator2DDataSourceListItemGenerator2DSharedPtr
 
typedef shared_ptr< DataSourceListItemGenerator3DDataSourceListItemGenerator3DSharedPtr
 
typedef shared_ptr< DataSourceDataSourceSharedPtr
 
typedef weak_ptr< DataSourceDataSourceWeakPtr
 
using DataTriggerComponentSharedPtr
 
using DataTriggerSharedPtr
 
using DataTriggerTemplateConstSharedPtr
 
using DataTriggerTemplateSharedPtr
 
typedef boost::mt19937 default_random_engine
 
typedef shared_ptr< DispatchMessageActionDispatchMessageActionSharedPtr
 
using DistanceFilterRuntimeSharedPtr
 Frustum cull filter runtime shared pointer type.
 
using DistanceFilterSharedPtr
 Distance filter shared pointer type.
 
typedef shared_ptr< DockLayout2DDockLayout2DSharedPtr
 
typedef shared_ptr< DockLayout3DDockLayout3DSharedPtr
 DockLayout shared pointer.
 
using DragAndDropManipulatorSharedPtr
 
using DrawObjectsRenderPassSharedPtr
 DrawObjectsRenderPass shared pointer type.
 
using DrawObjectsRenderPassWeakPtr
 
typedef shared_ptr< DrawObjectsWithMaterialRenderPassDrawObjectsWithMaterialRenderPassSharedPtr
 DrawObjectsWithMaterialRenderPass shared pointer type.
 
using EffectStack2DSharedPtr
 Effect stack shared pointer type.
 
using EffectStackRenderer2DUniquePtr
 
typedef shared_ptr< EmptyNode2DEmptyNode2DSharedPtr
 
typedef shared_ptr< EmptyNode3DEmptyNode3DSharedPtr
 
using EventSourceSharedPtr
 EventSource shared pointer type.
 
typedef shared_ptr< ExclusiveActivityHost2DExclusiveActivityHost2DSharedPtr
 ExclusiveActivityHost2D shared pointer.
 
typedef shared_ptr< ExclusiveActivityHost3DExclusiveActivityHost3DSharedPtr
 ExclusiveActivityHost3D shared pointer.
 
using ExecuteLuaActionSharedPtr
 
typedef shared_ptr< ExpressionBindingProcessorExpressionBindingProcessorSharedPtr
 Expression binding processor shared pointer type.
 
typedef shared_ptr< ExpressionBindingRuntimeExpressionBindingRuntimeSharedPtr
 ExpressionBindingRuntime shared pointer type.
 
typedef shared_ptr< ExpressionBindingExpressionBindingSharedPtr
 ExpressionBinding shared pointer type.
 
typedef shared_ptr< ExpressionConditionExpressionConditionSharedPtr
 
using FilterObjectSourceRuntimeSharedPtr
 Filter object source runtime shared pointer type.
 
using FilterObjectSourceSharedPtr
 Filter object source shared pointer type.
 
using FloatAnimation
 
using FloatAnimationSharedPtr
 
typedef FromToAnimation< float, function< float(float)> > FloatCustomFromToAnimation
 
typedef shared_ptr< FloatCustomFromToAnimationFloatCustomFromToAnimationSharedPtr
 
typedef KeyframeAnimation< floatFloatKeyframeAnimation
 
typedef shared_ptr< FloatKeyframeAnimationFloatKeyframeAnimationSharedPtr
 
typedef FromToAnimation< float, LinearEasingFunctionFloatLinearFromToAnimation
 
typedef shared_ptr< FloatLinearFromToAnimationFloatLinearFromToAnimationSharedPtr
 
typedef shared_ptr< FloatValueAccumulatorFloatValueAccumulatorSharedPtr
 
typedef shared_ptr< FlowLayout2DFlowLayout2DSharedPtr
 
typedef shared_ptr< FlowLayout3DFlowLayout3DSharedPtr
 FlowLayout shared pointer.
 
using FocusNavigationManipulatorSharedPtr
 
using FocusScopePtr
 
using FontEnginePluginSharedPtr
 
using FontFamilySharedPtr
 
using FontFileSharedPtr
 
using FontLoaderPtr
 
using FontRuntimeSharedPtr
 
typedef shared_ptr< ForwardingActionForwardingActionSharedPtr
 
using ForwardingApplyActionSharedPtr
 
using FramebufferPtr
 
using FramebufferSharedPtr
 Framebuffer shared pointer type.
 
using FrustumCullFilterRuntimeSharedPtr
 Frustum cull filter runtime shared pointer type.
 
using FrustumCullFilterSharedPtr
 Frustum cull filter shared pointer type.
 
using GatherLightsRenderPassSharedPtr
 GatherLightsRenderPass shared pointer type.
 
using GatherNearestLightsRenderPassSharedPtr
 GatherLightsRenderPass shared pointer type.
 
using GeometrySharedPtr
 Geometry shared pointer type.
 
using GLGraphicsOutputSharedPtr
 GLGraphicsOutput shared pointer type.
 
using GLSwizzleMask
 
using GlyphCacheManagerPtr
 
using GlyphCacheSharedPtr
 Glyph cache shared pointer type.
 
using GlyphCacheUniquePtr
 Glyph cache unique pointer type.
 
using GlyphKey
 Key type of a glyph cache map.
 
using GPUBufferUniquePtr
 
using GraphicsOutputSharedPtr
 GraphicsOutput shared pointer type.
 
typedef shared_ptr< GridLayout2DGridLayout2DSharedPtr
 GridLayout2D shared pointer.
 
typedef shared_ptr< GridLayout3DGridLayout3DSharedPtr
 GridLayout3D shared pointer.
 
typedef shared_ptr< GridListBox2DGridListBox2DSharedPtr
 
typedef shared_ptr< GridListBox3DGridListBox3DSharedPtr
 
typedef shared_ptr< Image2DImage2DSharedPtr
 Image2D shared pointer type.
 
using ImmutableIteratorRangeSharedPtr
 Shared pointer type for ImmutableIteratorRange.
 
using ImmutableSplitStringRangeSharedPtr
 Immutable split string range shared pointer type.
 
using IndexedPropertyAccessRangeSharedPtr
 Indexed property access range shared pointer type.
 
using IndexedViewRangeSharedPtr
 
typedef shared_ptr< InputManipulatorInputManipulatorBaseSharedPtr
 
using InputManipulatorSharedPtr
 
using InputManipulatorWeakPtr
 
using InputMethodBackendSharedPtr
 
using InputMethodSharedPtr
 
using InputMethodWeakPtr
 
using Instantiator3DSharedPtr
 Instantiator3DNode shared pointer.
 
using InstructionBindingProcessorRuntimePtr
 
using IntAnimation
 
using IntAnimationSharedPtr
 
typedef ProfilerRegistry< IntervalProfilerIntervalProfilerRegistry
 The interval profiler registry type.
 
typedef shared_ptr< IntervalProfilerIntervalProfilerSharedPtr
 The shared pointer to the interval profiler.
 
typedef KeyframeAnimation< intIntKeyframeAnimation
 
typedef shared_ptr< IntKeyframeAnimationIntKeyframeAnimationSharedPtr
 
typedef shared_ptr< IntValueAccumulatorIntValueAccumulatorSharedPtr
 
using IteratorRangeSharedPtr
 Iterator iterator shared pointer type.
 
using IteratorRangeWeakPtr
 Iterator iterator weak pointer type.
 
using ItypeThaiDictionarySharedPtr
 
using JNI_CreateJavaVMPtr
 
using JNI_GetCreatedJavaVMsPtr
 
using KeyManipulatorComponentSharedPtr
 
typedef shared_ptr< KeyManipulatorKeyManipulatorSharedPtr
 
typedef struct TouchPoint KzuInputTouchPoint
 
using LegacyGraphicsOutputSharedPtr
 LegacyGraphicsOutput shared pointer type.
 
typedef shared_ptr< LegacyRenderPassLegacyRenderPassSharedPtr
 LegacyRenderpass shared pointer type.
 
typedef shared_ptr< LevelOfDetail3DLevelOfDetail3DSharedPtr
 LevelOfDetail3D shared pointer type.
 
using LightSharedPtr
 Light shared pointer type.
 
using LightWeakPtr
 Light weak pointer type.
 
typedef shared_ptr< ListBoxItemContainer2DListBoxItemContainer2DSharedPtr
 
typedef shared_ptr< ListBoxItemContainer3DListBoxItemContainer3DSharedPtr
 
typedef shared_ptr< ListBoxItemGenerator2DListBoxItemGenerator2DSharedPtr
 
typedef shared_ptr< ListBoxItemGenerator3DListBoxItemGenerator3DSharedPtr
 
using LongPressManipulatorComponentSharedPtr
 
using LongPressManipulatorSharedPtr
 
using LuaInstancePtr
 
using MainLoopProfilerSharedPtr
 Alias for shared pointer to Main Loop Profiler.
 
using MainLoopProfilingScopeToken
 Alias for token used to identify a main loop profiling scope.
 
using MainLoopTaskToken
 Type alias for an opaque handle to a MainLoopScheduler task.
 
using MainLoopTimerToken
 Type alias for an opaque handle to a MainLoopScheduler timer.
 
typedef shared_ptr< ManualBindingRuntimeManualBindingRuntimeSharedPtr
 ManualBindingRuntime shared pointer type.
 
typedef shared_ptr< ManualBindingManualBindingSharedPtr
 Manual binding shared pointer type.
 
using MaskEffect2DSharedPtr
 Mask effect shared pointer type.
 
using MaskEffectRenderer2DUniquePtr
 Mask effect renderer unique pointer type.
 
using MaterialBrushSharedPtr
 Shared pointer definition.
 
typedef shared_ptr< MaterialSetupRenderPassMaterialSetupRenderPassSharedPtr
 MaterialSetupRenderPass shared pointer type.
 
using MaterialSharedPtr
 Material shared pointer type.
 
using MaterialWeakPtr
 Material shared pointer type.
 
typedef vector< MeshVertexAttributeMeshAttributeCollection
 
typedef MeshAttributeCollection::const_iterator MeshAttributeCollectionConstIterator
 
typedef MeshAttributeCollection::iterator MeshAttributeCollectionIterator
 
typedef shared_ptr< const MeshMeshConstSharedPtr
 
using MeshSharedPtr
 
typedef shared_ptr< MessageTriggerMessageTriggerSharedPtr
 
typedef shared_ptr< MetaObjectMetaObjectSharedPtr
 MetaObject shared pointer type.
 
typedef shared_ptr< Model3DModel3DSharedPtr
 Model3D shared pointer type.
 
using ModuleSharedPtr
 
using MorphRuntimePtr
 Morph runtime unique pointer type.
 
using MorphSharedPtr
 
typedef shared_ptr< MorphWeightTimelinePlaybackMorphWeightTimelinePlaybackSharedPtr
 
using MorphWeightTimelineSharedPtr
 
typedef shared_ptr< MoveFocusActionMoveFocusActionSharedPtr
 
using MultiClickManipulatorComponentSharedPtr
 
using MultiClickManipulatorSharedPtr
 
typedef int NativeEventHandle
 
typedef TextureNativeFramebufferHandle
 
typedef voidNativeTextureHandle
 
using NavigationManipulatorComponentSharedPtr
 
using NavigationManipulatorSharedPtr
 
typedef shared_ptr< NinePatchImage2DNinePatchImage2DSharedPtr
 
typedef shared_ptr< Node2D constNode2DConstSharedPtr
 
typedef shared_ptr< Node2DNode2DSharedPtr
 
typedef weak_ptr< Node2DNode2DWeakPtr
 
typedef shared_ptr< const Node3DNode3DConstSharedPtr
 Node3D const shared pointer type.
 
using Node3DSharedPtr
 Node3D shared pointer type.
 
using Node3DWeakPtr
 Node3D weak pointer type.
 
typedef shared_ptr< NodeComponent constNodeComponentConstSharedPtr
 
typedef shared_ptr< NodeComponentNodeComponentSharedPtr
 
typedef shared_ptr< NodeComponentTemplate constNodeComponentTemplateConstSharedPtr
 
typedef shared_ptr< NodeComponentTemplateNodeComponentTemplateSharedPtr
 
using NodeCompositor2DPtr
 NodeCompositor2D unique pointer type.
 
typedef shared_ptr< Node constNodeConstSharedPtr
 Alias for shared pointer of const Node.
 
typedef weak_ptr< Node constNodeConstWeakPtr
 Alias for weak pointer of const Node.
 
using NodeEffect2DConstSharedPtr
 
using NodeEffect2DSharedPtr
 
using NodeEffectPrefab2DSharedPtr
 Node effect prefab shared pointer type.
 
using NodeEffectRenderer2DSharedPtr
 
using NodeEffectRenderer2DUniquePtr
 Node effect unique pointer type.
 
typedef shared_ptr< NodeEffectTemplate2DNodeEffectTemplate2DSharedPtr
 NodeEffectTemplate2D shared pointer type.
 
using NodeListRenderPassSharedPtr
 NodeListRenderPass shared pointer type.
 
using NodeListSharedPtr
 NodeList shared pointer type.
 
using NodeListWeakPtr
 NodeList weak pointer type.
 
using NodeSharedPtr
 Node shared pointer.
 
using NodeVisual2DPtr
 NodeVisual2D unique pointer type.
 
using NodeWeakPtr
 Alias for weak pointer of Node.
 
using NodeWeakPtrContainer
 
typedef shared_ptr< NullBrushNullBrushSharedPtr
 
typedef shared_ptr< ObjectPropertyExpressionValueSourceObjectPropertyExpressionValueSourceSharedPtr
 ObjectPropertyExpressionValueSource shared pointer type.
 
using ObjectSharedPtr
 Object shared pointer type.
 
using ObjectSourceRuntimeSharedPtr
 Shared pointer type for object source runtime.
 
using ObjectSourceSharedPtr
 Object source shared pointer type.
 
using ObjectSourceWeakPtr
 Object source weak pointer type.
 
using ObjectTypeFilterRuntimeSharedPtr
 Object type filter runtime shared pointer type.
 
using ObjectTypeFilterSharedPtr
 Object Type Filter shared pointer type.
 
typedef shared_ptr< OnAttachedTriggerOnAttachedTriggerSharedPtr
 
typedef shared_ptr< OnPropertyChangedTriggerOnPropertyChangedTriggerSharedPtr
 
template<typename Type >
using OptionalDynamicPropertyType
 
using OutlineEffect2DSharedPtr
 OutlineEffect2D shared pointer type.
 
using OutlineEffectRenderer2DUniquePtr
 OutlineEffectRenderer2D unique pointer type.
 
typedef shared_ptr< PageHostPageHostSharedPtr
 
typedef shared_ptr< PagePageSharedPtr
 
typedef shared_ptr< PageTransitionCollectionPageTransitionCollectionSharedPtr
 
typedef weak_ptr< PagePageWeakPtr
 
using PanManipulatorComponentSharedPtr
 
using PanManipulatorSharedPtr
 
typedef shared_ptr< ParallelActivityHost2DParallelActivityHost2DSharedPtr
 ParallelActivityHost2D shared pointer.
 
typedef shared_ptr< ParallelActivityHost3DParallelActivityHost3DSharedPtr
 ParallelActivityHost3D shared pointer.
 
typedef shared_ptr< ParallelTimelinePlaybackParallelTimelinePlaybackSharedPtr
 
typedef shared_ptr< ParallelTimelineParallelTimelineSharedPtr
 
typedef shared_ptr< PatchingNotificationHandlerPatchingNotificationHandlerSharedPtr
 Shared pointer to PatchingNotificationHandler.
 
using PinchManipulatorSharedPtr
 
typedef shared_ptr< PipelineStateRenderPassPipelineStateRenderPassSharedPtr
 PipelineStateRenderPass shared pointer type.
 
using PopupScope
 Implements the popup scopes.
 
typedef shared_ptr< PortalPortalSharedPtr
 
typedef shared_ptr< PrefabTemplateNodePrefabTemplateNodeSharedPtr
 
typedef weak_ptr< PrefabTemplateNodePrefabTemplateNodeWeakPtr
 
using PrefabTemplateSharedPtr
 
typedef shared_ptr< PrefabView2DPrefabView2DSharedPtr
 Prefab view 2D shared pointer.
 
typedef shared_ptr< PrefabView3DPrefabView3DSharedPtr
 Prefab view 3D shared pointer.
 
typedef shared_ptr< PreviewTimelinePlaybackPreviewTimelinePlaybackSharedPtr
 
typedef shared_ptr< PreviewTimelinePreviewTimelineSharedPtr
 
typedef shared_ptr< ResourceProfilingLoadTaskProfiledLoadTaskSharedPtr
 Profiled load task shared pointer type.
 
typedef shared_ptr< ProgressiveRenderingViewport2DProgressiveRenderingViewport2DSharedPtr
 
using PropertyAccessRangeSharedPtr
 Property access range shared pointer type.
 
typedef shared_ptr< PropertyAnimationTimelinePlaybackPropertyAnimationTimelinePlaybackSharedPtr
 
typedef shared_ptr< PropertyAnimationTimelinePropertyAnimationTimelineSharedPtr
 
typedef function< void()> PropertyChangedFunction
 
typedef shared_ptr< PropertyDrivenAnimationPlayerPropertyDrivenAnimationPlayerSharedPtr
 
typedef shared_ptr< PropertyFieldAnimationTimelinePlaybackPropertyFieldAnimationTimelinePlaybackSharedPtr
 
typedef shared_ptr< PropertyFieldAnimationTimelinePropertyFieldAnimationTimelineSharedPtr
 
typedef shared_ptr< PropertyFieldTargetInterpolationTimelinePlaybackPropertyFieldTargetInterpolationTimelinePlaybackSharedPtr
 
using PropertyIsEqualFilterRuntimeSharedPtr
 Contains property node filter runtime shared pointer type.
 
using PropertyIsEqualFilterSharedPtr
 Property Is Equal Filter shared pointer type.
 
using PropertyObjectSharedPtr
 PropertyObject shared pointer type.
 
using PropertyObjectWeakPtr
 PropertyObject weak pointer type.
 
using PropertyTargetEasingInterpolatorSharedPtr
 
using PropertyTargetEasingTimelinePlaybackSharedPtr
 
using PropertyTargetEasingTimelineSharedPtr
 
typedef shared_ptr< PropertyTargetInterpolationTimelinePlaybackPropertyTargetInterpolationTimelinePlaybackSharedPtr
 
typedef shared_ptr< PropertyTargetInterpolationTimelinePropertyTargetInterpolationTimelineSharedPtr
 
typedef shared_ptr< PropertyTargetInterpolatorPropertyTargetInterpolatorSharedPtr
 
typedef PropertyTypeEditorInfoPropertyTypeEditorInfoSharedPtr
 
using PropertyTypeRegistry
 Alias for map of all property types.
 
using RangeAccumulateBindingProcessorRuntimePtr
 RangeAccumulateBindingProcessorRuntime unique pointer type.
 
using RangeAccumulateBindingProcessorSharedPtr
 Iterator begin binding processor shared pointer type.
 
using RangeBindingProcessorRuntimePtr
 RangeBindingProcessorRuntime unique pointer type.
 
using RangeBindingProcessorSharedPtr
 RangeBindingProcessor shared pointer type.
 
typedef tuple< NodeSharedPtr, Ray, floatRayPickResult
 RayPick hit test result tuple.
 
typedef unique_ptr< ReadOnlyDiskFileReadOnlyDiskFileUniquePtr
 
using ReadOnlyMemoryFilePtr
 ReadOnlyMemoryFile unique pointer type.
 
typedef Rectangle< floatRectangleFloat
 Float type rectangle.
 
typedef Rectangle< intRectangleInteger
 Integer type rectangle.
 
using RenderbufferSharedPtr
 Renderbuffer shared pointer type.
 
using RenderEntry3DPtr
 Render state association unique pointer type.
 
using RendererSharedPtr
 
typedef shared_ptr< RenderPass constRenderPassConstSharedPtr
 RenderPass const shared pointer type.
 
using RenderPassPrefabSharedPtr
 Render pass template shared pointer type.
 
typedef shared_ptr< RenderPassRenderPassSharedPtr
 RenderPass shared pointer type.
 
typedef shared_ptr< RenderPassTemplateRenderPassTemplateSharedPtr
 RenderPassTemplate shared pointer type.
 
typedef shared_ptr< RenderPassViewRenderPassViewSharedPtr
 RenderPassView shared pointer type.
 
typedef weak_ptr< RenderPassRenderPassWeakPtr
 RenderPass weak pointer type.
 
using RenderPropertyExpressionValueSourceSharedPtr
 ObjectPropertyExpressionValueSource shared pointer type.
 
using RenderStatePropertyNotificationHandlerPtr
 Render state property notification handler unique pointer type.
 
using ResourceBindingProcessorRuntimePtr
 ResourceBindingProcessorRuntime unique pointer type.
 
using ResourceBindingProcessorSharedPtr
 Resource binding processor shared pointer type.
 
typedef shared_ptr< ResourceDictionarySelectorResourceDictionarySelectorSharedPtr
 Resource dictionary selector shared pointer.
 
typedef shared_ptr< ResourceDictionaryResourceDictionarySharedPtr
 Resource dictionary shared pointer.
 
using ResourceIDAnimation
 
using ResourceIDAnimationSharedPtr
 
typedef KeyframeAnimation< ResourceIDResourceIDKeyframeAnimation
 
typedef shared_ptr< ResourceIDKeyframeAnimationResourceIDKeyframeAnimationSharedPtr
 
typedef shared_ptr< ResourceManagerResourceManagerSharedPtr
 Resource manager shared pointer type.
 
typedef unique_ptr< ResourceProfilerResourceProfilerUniquePtr
 The resource profiler unique ptr type.
 
typedef unique_ptr< ResourceProfilingContextFactoryResourceProfilingContextFactoryUniquePtr
 The resource profiling context factory unique pointer type.
 
typedef shared_ptr< ResourceProfilingContextResourceProfilingContextSharedPtr
 
typedef shared_ptr< ResourceProfilingDataSampleResourceProfilingDataSampleSharedPtr
 Profiled resource shared pointer type.
 
using ResourceSharedPtr
 Resource shared pointer type.
 
using ResourceWeakPtr
 Resource weak pointer type.
 
using SceneSharedPtr
 Scene shared pointer.
 
using ScreenSharedPtr
 Screen shared pointer.
 
using ScriptingContextSharedPtr
 Alias for an opaque handle to the scripting context of an object.
 
typedef shared_ptr< ScrollView2DScrollView2DSharedPtr
 
typedef shared_ptr< ScrollView3DScrollView3DSharedPtr
 
typedef shared_ptr< SetPropertyActionSetPropertyActionSharedPtr
 
typedef vector< ShaderVertexAttributeShaderAttributeCollection
 
typedef ShaderAttributeCollection::const_iterator ShaderAttributeCollectionConstIterator
 
typedef ShaderAttributeCollection::iterator ShaderAttributeCollectionIterator
 
using ShaderProgramSharedPtr
 Shader program shared pointer type.
 
typedef unordered_map< ShaderProgram *, vector< int > > ShaderProgramToAttributeMapSet
 
using ShaderProgramWeakPtr
 Shader program weak pointer type.
 
using ShadowEffect2DSharedPtr
 Shadow effect shared pointer type.
 
using ShadowEffectRenderer2DUniquePtr
 Shadow effect renderer unique pointer type.
 
typedef Slider2DConceptImpl< RangeConceptImpl< Node2D, Slider2D >, Slider2DPresenterType, Slider2DSlider2DConceptImplType
 
typedef SliderTrajectoryPresenter< TrajectoryLayout2D, Slider2D, Trajectory2DInputHandler< TrajectoryLayout2D, Slider2D > > Slider2DPresenterType
 
typedef shared_ptr< Slider2DSlider2DSharedPtr
 Trajectory Slider shared pointer.
 
typedef Slider3DConceptImpl< RangeConceptImpl< Node3D, Slider3D >, Slider3DPresenterType, Slider3DSlider3DConceptImplType
 
typedef SliderTrajectoryPresenter< TrajectoryLayout3D, Slider3D, Trajectory3DInputHandler< TrajectoryLayout3D, Slider3D > > Slider3DPresenterType
 
typedef shared_ptr< Slider3DSlider3DSharedPtr
 Trajectory Slider shared pointer.
 
using SortByShaderObjectSourceRuntimeSharedPtr
 Frustum cull filter runtime shared pointer type.
 
using SortByShaderObjectSourceSharedPtr
 Sort object source shared pointer type.
 
using SortByZObjectSourceRuntimeSharedPtr
 Frustum cull filter runtime shared pointer type.
 
using SortByZObjectSourceSharedPtr
 Sort object source shared pointer type.
 
using SortObjectSourceSharedPtr
 Sort object source shared pointer type.
 
typedef unique_ptr< SplineSplinePtr
 Spline unique pointer type.
 
using SplitStringRangeSharedPtr
 Split string range shared pointer type.
 
using SRTValue2DAnimation
 
using SRTValue2DAnimationSharedPtr
 
using SRTValue3DAnimation
 
using SRTValue3DAnimationSharedPtr
 
typedef shared_ptr< StackLayout2DStackLayout2DSharedPtr
 Stack layout shared pointer.
 
typedef shared_ptr< StackLayout3DStackLayout3DSharedPtr
 StackLayout shared pointer.
 
typedef unique_ptr< StartupProfilerRegistryStartupProfilerRegistryUniquePtr
 The startup profiler registry unique ptr type.
 
typedef shared_ptr< StateManagerStateManagerSharedPtr
 
typedef weak_ptr< StateManagerStateManagerWeakPtr
 
using StringAnimation
 
using StringAnimationSharedPtr
 
typedef KeyframeAnimation< string > StringKeyframeAnimation
 
typedef shared_ptr< StringKeyframeAnimationStringKeyframeAnimationSharedPtr
 
typedef shared_ptr< StyleStyleSharedPtr
 Style shared pointer type.
 
typedef shared_ptr< SurfaceSurfaceSharedPtr
 Surface shared pointer type.
 
using SystemConfiguration
 
typedef vector< string_view > SystemProperties
 Read-only values from the system.
 
using TagFilterRuntimeSharedPtr
 Tag filter runtime shared pointer type.
 
using TagFilterSharedPtr
 Tag Filter shared pointer type.
 
using TargetPreviewServerSharedPtr
 
typedef shared_ptr< TextBlock2DTextBlock2DSharedPtr
 TextLayer shared pointer.
 
typedef shared_ptr< TextBlock3DTextBlock3DSharedPtr
 TextBlock shared pointer.
 
using TextBox2DSharedPtr
 
typedef shared_ptr< TextBox3DTextBox3DSharedPtr
 
using TextBreakIteratorObjectPtr
 
typedef unique_ptr< TextFormatTextFormatPtr
 Text format unique pointer.
 
using TextInputManipulatorSharedPtr
 
using TextManagerShareedPtr
 
using TextManagerUniquePtr
 
typedef shared_ptr< TextResourceTextResourceSharedPtr
 Text resource shared pointer.
 
typedef unique_ptr< TextShaperTextShaperPtr
 
typedef shared_ptr< TextureBrushTextureBrushSharedPtr
 Shared pointer definition.
 
using TextureSharedPtr
 Texture shared pointer type.
 
using TextureWeakPtr
 
typedef std::thread::native_handle_type ThreadNativeHandleType
 
typedef shared_ptr< TimelineClockTimelineClockSharedPtr
 
using TimelinePlaybackSharedPtr
 
typedef shared_ptr< TimelineResourceTimelineResourceSharedPtr
 
using TimelineSharedPtr
 
using TimePoint
 
typedef shared_ptr< TimerTriggerTimerTriggerSharedPtr
 
using ToggleButton2DSharedPtr
 
using ToggleButton3DSharedPtr
 
using ToggleButtonGroup2DSharedPtr
 ToggleButtonGroup2D shared pointer.
 
using ToggleButtonGroup3DSharedPtr
 ToggleButtonGroup3D shared pointer.
 
typedef shared_ptr< ToSourceBindingRuntimeToSourceBindingRuntimeSharedPtr
 ToSourceBindingRuntime shared pointer type.
 
typedef shared_ptr< ToSourceBindingToSourceBindingSharedPtr
 ToSourceBinding shared pointer type.
 
typedef shared_ptr< TrajectoryLayout2DTrajectoryLayout2DSharedPtr
 TrajectoryLayout shared pointer.
 
typedef shared_ptr< TrajectoryLayout3DTrajectoryLayout3DSharedPtr
 TrajectoryLayout shared pointer.
 
typedef shared_ptr< TrajectoryListBox3DTrajectoryListBox3DSharedPtr
 
typedef shared_ptr< TrajectoryTrajectorySharedPtr
 Trajectory shared pointer type.
 
typedef shared_ptr< TriggerTriggerSharedPtr
 
using TriggerTemplateConstSharedPtr
 
using TriggerTemplateSharedPtr
 
typedef shared_ptr< TrySetFocusActionTrySetFocusActionSharedPtr
 
typedef shared_ptr< TwoWayBindingRuntimeTwoWayBindingRuntimeSharedPtr
 TwoWayBindingRuntime shared pointer type.
 
typedef shared_ptr< TwoWayBindingTwoWayBindingSharedPtr
 TwoWayBinding shared pointer type.
 
using TypedFloatValueRange
 
using TypedFloatValueRangeSharedPtr
 
typedef unique_ptr< InputEventUniqueEventPtr
 
typedef unordered_set< string > UrlContainer
 
using ValueRangeSharedPtr
 Value iterator shared pointer type.
 
using ValueRangeWeakPtr
 Value iterator weak pointer type.
 
using VariableBindingHostSharedPtr
 Shared pointer type for variable binding host.
 
using VariableExpressionValueSourceSharedPtr
 ObjectPropertyExpressionValueSource shared pointer type.
 
using Vector2Animation
 
using Vector2AnimationSharedPtr
 
typedef KeyframeAnimation< Vector2Vector2KeyframeAnimation
 
typedef shared_ptr< Vector2KeyframeAnimationVector2KeyframeAnimationSharedPtr
 
using Vector3Animation
 
using Vector3AnimationSharedPtr
 
typedef KeyframeAnimation< Vector3Vector3KeyframeAnimation
 
typedef shared_ptr< Vector3KeyframeAnimationVector3KeyframeAnimationSharedPtr
 
using Vector4Animation
 
using Vector4AnimationSharedPtr
 
typedef KeyframeAnimation< Vector4Vector4KeyframeAnimation
 
typedef shared_ptr< Vector4KeyframeAnimationVector4KeyframeAnimationSharedPtr
 
typedef shared_ptr< Viewport2DViewport2DSharedPtr
 Viewport2D shared pointer type.
 
using Viewport3DSharedPtr
 
typedef Rectangle< intViewportRectangle
 Viewport rectangle definition.
 
using ViewRangeSharedPtr
 
typedef string Win32String
 
typedef string_view Win32StringView
 
using WindowedGraphicsOutputSharedPtr
 WindowedGraphicsOutput shared pointer type.
 
using WindowsImeSharedPtr
 
typedef shared_ptr< WriteLogActionWriteLogActionSharedPtr
 
typedef unique_ptr< WriteOnlyDiskFileWriteOnlyDiskFileUniquePtr
 
using NamedIntervalProfilerSharedPtr
 The shared pointer to the interval profiler.
 
using NamedIntervalProfilerRegistry
 The interval profiler registry type.
 

Enumerations

enum  AnimationEasingMode { AnimationEaseIn , AnimationEaseOut , AnimationEaseInOut }
 Easing mode to use to apply an easing function. More...
 
enum  BindingBinaryTargetType { BindingTargetTypeValueSource , BindingTargetTypeModifier , BindingTargetTypeRenderValue , BindingTargetTypeVariable }
 Binding precedence (binary file). More...
 
enum  BindingExpressionArgumentType : int16_t {
  BindingExpressionArgumentTypeTemporaryRegister0 , BindingExpressionArgumentTypeTemporaryRegister1 , BindingExpressionArgumentTypeTemporaryRegister2 , BindingExpressionArgumentTypeTemporaryRegister3 ,
  BindingExpressionArgumentTypeTemporaryRegister4 , BindingExpressionArgumentTypeTemporaryRegister5 , BindingExpressionArgumentTypeTemporaryRegister6 , BindingExpressionArgumentTypeConstantRegister0 ,
  BindingExpressionArgumentTypeConstantRegister1 , BindingExpressionArgumentTypeConstantRegister2 , BindingExpressionArgumentTypeConstantRegister3 , BindingExpressionArgumentTypeConstantRegister4 ,
  BindingExpressionArgumentTypeConstantRegister5 , BindingExpressionArgumentTypeConstantRegister6 , BindingExpressionArgumentTypeSourceRegister0 , BindingExpressionArgumentTypeSourceRegister1 ,
  BindingExpressionArgumentTypeSourceRegister2 , BindingExpressionArgumentTypeSourceRegister3 , BindingExpressionArgumentTypeSourceRegister4 , BindingExpressionArgumentTypeSourceRegister5 ,
  BindingExpressionArgumentTypeSourceRegister6 , BindingExpressionArgumentTypeDataSourceRegister0 , BindingExpressionArgumentTypeDataSourceRegister1 , BindingExpressionArgumentTypeDataSourceRegister2 ,
  BindingExpressionArgumentTypeDataSourceRegister3 , BindingExpressionArgumentTypeDataSourceRegister4 , BindingExpressionArgumentTypeDataSourceRegister5 , BindingExpressionArgumentTypeDataSourceRegister6
}
 Runtime expression validator argument type. More...
 
enum  BindingMode { BindingModeInvalid , BindingModeOneWay , BindingModeTwoWay , BindingModeToSource }
 Binding mode (binary file). More...
 
enum  BlendAdvancedEquation : int32_t { BlendAdvancedEquationNone , BlendAdvancedEquationComponentMask }
 Specifies the blend equations for the advanced blend modes. More...
 
enum  BlendAlphaEquation : int32_t {
  BlendAlphaEquationNone , BlendAlphaEquationAdd , BlendAlphaEquationSubtract , BlendAlphaEquationReverseSubtract ,
  BlendAlphaEquationMin , BlendAlphaEquationMax , BlendAlphaEquationComponentMask
}
 Blend equation for alpha. More...
 
enum  BlendColorEquation : int32_t {
  BlendColorEquationNone , BlendColorEquationAdd , BlendColorEquationSubtract , BlendColorEquationReverseSubtract ,
  BlendColorEquationMin , BlendColorEquationMax , BlendColorEquationComponentMask
}
 Blend equation for color. More...
 
enum  BlendComponentBitShift : int8_t {
  BlendComponentBitShiftSrcColor , BlendComponentBitShiftSrcAlpha , BlendComponentBitShiftDstColor , BlendComponentBitShiftDstAlpha ,
  BlendComponentBitShiftEquationColor , BlendComponentBitShiftEquationAlpha , BlendComponentBitShiftEquationAdvanced
}
 Blend component bit shifts. More...
 
enum  BlendDstAlphaFactor : int32_t {
  BlendDstAlphaFactorZero , BlendDstAlphaFactorOne , BlendDstAlphaFactorSrcAlpha , BlendDstAlphaFactorOneMinusSrcAlpha ,
  BlendDstAlphaFactorDstAlpha , BlendDstAlphaFactorOneMinusDstAlpha , BlendDstAlphaFactorConstantAlpha , BlendDstAlphaFactorOneMinusConstantAlpha ,
  BlendDstAlphaFactorMask
}
 Blend factor for destination alpha. More...
 
enum  BlendDstColorFactor : int32_t {
  BlendDstColorFactorZero , BlendDstColorFactorOne , BlendDstColorFactorSrcColor , BlendDstColorFactorOneMinusSrcColor ,
  BlendDstColorFactorDstColor , BlendDstColorFactorOneMinusDstColor , BlendDstColorFactorSrcAlpha , BlendDstColorFactorOneMinusSrcAlpha ,
  BlendDstColorFactorDstAlpha , BlendDstColorFactorOneMinusDstAlpha , BlendDstColorFactorConstantColor , BlendDstColorFactorOneMinusConstantColor ,
  BlendDstColorFactorConstantAlpha , BlendDstColorFactorOneMinusConstantAlpha , BlendDstColorFactorSrcAlphaSaturate , BlendDstColorFactorMask
}
 Blend factor for destination color. More...
 
enum  BlendEquation : int8_t {
  BlendEquationNone , BlendEquationAdd , BlendEquationSubtract , BlendEquationReverseSubtract ,
  BlendEquationMin , BlendEquationMax , BlendEquationMask
}
 Blend equation. More...
 
enum  BlendEquationAdvanced : int8_t {
  BlendEquationAdvancedNone , BlendEquationMultiply , BlendEquationOverlay , BlendEquationDarken ,
  BlendEquationLighten , BlendEquationColorBurn , BlendEquationColorDodge , BlendEquationHardLight ,
  BlendEquationSoftLight , BlendEquationDifference , BlendEquationExclusion , BlendEquationHSLHue ,
  BlendEquationHSLSaturation , BlendEquationHSLColor , BlendEquationHSLLuminosity
}
 Specifies the advanced blend modes. More...
 
enum  BlendFactor : int8_t {
  BlendFactorZero , BlendFactorOne , BlendFactorSrcColor , BlendFactorOneMinusSrcColor ,
  BlendFactorDstColor , BlendFactorOneMinusDstColor , BlendFactorSrcAlpha , BlendFactorOneMinusSrcAlpha ,
  BlendFactorDstAlpha , BlendFactorOneMinusDstAlpha , BlendFactorConstantColor , BlendFactorOneMinusConstantColor ,
  BlendFactorConstantAlpha , BlendFactorOneMinusConstantAlpha , BlendFactorSrcAlphaSaturate , BlendFactorMask
}
 Blend mode representation. More...
 
enum  BlendSrcAlphaFactor : int32_t {
  BlendSrcAlphaFactorZero , BlendSrcAlphaFactorOne , BlendSrcAlphaFactorSrcAlpha , BlendSrcAlphaFactorOneMinusSrcAlpha ,
  BlendSrcAlphaFactorDstAlpha , BlendSrcAlphaFactorOneMinusDstAlpha , BlendSrcAlphaFactorConstantAlpha , BlendSrcAlphaFactorOneMinusConstantAlpha ,
  BlendSrcAlphaFactorMask
}
 Blend factor for source alpha. More...
 
enum  BlendSrcColorFactor : int32_t {
  BlendSrcColorFactorZero , BlendSrcColorFactorOne , BlendSrcColorFactorSrcColor , BlendSrcColorFactorOneMinusSrcColor ,
  BlendSrcColorFactorDstColor , BlendSrcColorFactorOneMinusDstColor , BlendSrcColorFactorSrcAlpha , BlendSrcColorFactorOneMinusSrcAlpha ,
  BlendSrcColorFactorDstAlpha , BlendSrcColorFactorOneMinusDstAlpha , BlendSrcColorFactorConstantColor , BlendSrcColorFactorOneMinusConstantColor ,
  BlendSrcColorFactorConstantAlpha , BlendSrcColorFactorOneMinusConstantAlpha , BlendSrcColorFactorSrcAlphaSaturate , BlendSrcColorFactorMask
}
 Blend factor for source color. More...
 
enum  CachingMode { CachingModeDisabled , CachingModeEnabled , CachingModeAutomatic }
 Caching modes for nodes. More...
 
enum class  CapsLockState { Ignore , On , Off }
 The required Caps Lock state for a key gesture. More...
 
enum class  ColorWorkflow { Legacy , Linear }
 The Color Workflow for an application. More...
 
enum  DrawBuffers { DrawBuffersNone , DrawBuffersDefault , DrawBuffersExt , DrawBuffersNV }
 Draw multiple buffers support code path in Renderer. More...
 
enum class  EchoMode { Normal , NoEcho , Password }
 Echo modes that specify how to format the display text in a TextEditBuffer. More...
 
enum class  EGLContextClientSelection {
  Version1 , Version2 , Version3 , Unspecified ,
  Automatic
}
 Represents your selection of the EGL context client version. More...
 
enum class  EGLContextClientVersion : int { Version1 , Version2 , Version3 }
 EGL context client version. More...
 
enum class  EGLIMGContextPriority : int { High , Medium , Low }
 EGL IMG context priorities. More...
 
enum class  EGLSurfaceType : int { Window , Pbuffer , Pixmap }
 EGL surface types. More...
 
enum  FixedMatrix {
  FixedMatrixProjection , FixedMatrixCamera , FixedMatrixWorld , FixedMatrixCameraWorld ,
  FixedMatrixProjectionCameraWorld , FixedMatrixCount
}
 List of active matrices renderer keeps track of. More...
 
enum  FloatTexture { FloatTextureNone , FloatTextureARB , FloatTextureES3 , FloatTextureES2Ext }
 Float texture support code path in Renderer. More...
 
enum class  FocusChainDirection { Previous , Next }
 Specifies the directions of focus move. More...
 
enum class  FocusFallback { None , Parent , Overlay }
 Fallback behavior to follow if node fails to gain focus. More...
 
enum class  FocusOnPress { None , Node , NodeOrAncestor , NodeOrOverlay }
 Focus behavior on node press. More...
 
enum class  FocusReason {
  Force , FocusChainNavigation , Hidden , ForceToRootNode ,
  Other
}
 Specifies the reason the node is focused. More...
 
enum class  FocusScopeType : int {
  NoScope , Group , Fence , Modal ,
  AutoClosingModal , Popup , Modeless , AutoClosingModeless
}
 Specifies focus scope types. More...
 
enum class  FocusState { NoFocus , LogicalFocus , KeyboardFocus , KeyFocus }
 Specifies the focus states of a node. More...
 
enum class  FontHintingPreference : int8_t { NoHinting , NativeHinting , AutoHinting }
 Font hinting options. More...
 
enum class  FontStyle : int8_t { Normal , Italic }
 Font style options. More...
 
enum class  FontWeight : int8_t {
  Thin , ExtraLight , Light , Normal ,
  Medium , SemiBold , Bold , ExtraBold ,
  Black
}
 Font weight options. More...
 
enum  FramebufferAttachmentPoint {
  FramebufferAttachmentPointColor0 , FramebufferAttachmentPointColor1 , FramebufferAttachmentPointColor2 , FramebufferAttachmentPointColor3 ,
  FramebufferAttachmentPointDepthStencil , FramebufferAttachmentPointCount
}
 
enum  FramebufferTarget { FramebufferTargetReadAndDraw , FramebufferTargetRead , FramebufferTargetDraw }
 Framebuffer target selects draw or read framebuffer, or both. More...
 
enum  GraphicsClearTarget {
  GraphicsClearTargetColor0 , GraphicsClearTargetColor1 , GraphicsClearTargetColor2 , GraphicsClearTargetColor3 ,
  GraphicsClearTargetDepth , GraphicsClearTargetStencil , GraphicsClearTargetCoverage
}
 Clear target options for renderer. More...
 
enum  GraphicsColorWriteMode {
  GraphicsColorWriteModeNone , GraphicsColorWriteModeRGB , GraphicsColorWriteModeRGBA , GraphicsColorWriteModeR ,
  GraphicsColorWriteModeG , GraphicsColorWriteModeB , GraphicsColorWriteModeGB , GraphicsColorWriteModeA
}
 List of color write modes. More...
 
enum  GraphicsCompareFunction {
  GraphicsCompareFunctionNever , GraphicsCompareFunctionAlways , GraphicsCompareFunctionLess , GraphicsCompareFunctionLessOrEqual ,
  GraphicsCompareFunctionGreater , GraphicsCompareFunctionGreaterOrEqual , GraphicsCompareFunctionEqual , GraphicsCompareFunctionNotEqual ,
  GraphicsCompareFunctionDisabled
}
 Renderer stencil modes. More...
 
enum class  GraphicsContextAPI { Unspecified , WGL , EGL , GLX }
 Graphics context API for a surface. More...
 
enum  GraphicsCullMode { GraphicsCullModeNone , GraphicsCullModeBack , GraphicsCullModeFront }
 List of available cull modes. More...
 
enum  GraphicsDataType {
  GraphicsDataTypeNone , GraphicsDataTypeUNORM8 , GraphicsDataTypeSNORM8 , GraphicsDataTypeUNORM16 ,
  GraphicsDataTypeSNORM16 , GraphicsDataTypeUNORM32 , GraphicsDataTypeSNORM32 , GraphicsDataTypeUNORM_PACK16_5_6_5 ,
  GraphicsDataTypeCOMPRESSED , GraphicsDataTypeUINT8 , GraphicsDataTypeSINT8 , GraphicsDataTypeUINT16 ,
  GraphicsDataTypeSINT16 , GraphicsDataTypeUINT32 , GraphicsDataTypeSINT32 , GraphicsDataTypeSFLOAT16 ,
  GraphicsDataTypeSFLOAT32 , GraphicsDataTypeUNORM24 , GraphicsDataTypeUNORM24_UINT8 , GraphicsDataTypeUNORM_PACK32_2_10_10_10 ,
  GraphicsDataTypeSNORM_PACK32_2_10_10_10 , GraphicsDataTypeNative
}
 GraphicsDataType is used to specify type of data in textures and vertex buffers. More...
 
enum  GraphicsElementType { GraphicsElementTypeUINT , GraphicsElementTypeSINT , GraphicsElementTypeFLOAT }
 GraphicsElementType is used to specify type of element of data consumed by shaders. More...
 
enum  GraphicsFillMode { GraphicsFillModeSolid , GraphicsFillModeWireframe }
 
enum  GraphicsFormat {
  GraphicsFormatNone , GraphicsFormatLUMINANCE8_UNORM , GraphicsFormatALPHA8_UNORM , GraphicsFormatLUMINANCE8_ALPHA8_UNORM ,
  GraphicsFormatR8_UNORM , GraphicsFormatR8_UINT , GraphicsFormatR8_SINT , GraphicsFormatR8G8_UNORM ,
  GraphicsFormatR8G8_UINT , GraphicsFormatR8G8_SINT , GraphicsFormatR8G8B8_UNORM , GraphicsFormatR8G8B8_SRGB ,
  GraphicsFormatR8G8B8_UINT , GraphicsFormatR8G8B8_SINT , GraphicsFormatR8G8B8A8_UNORM , GraphicsFormatR8G8B8A8_SRGB ,
  GraphicsFormatR8G8B8A8_UINT , GraphicsFormatR8G8B8A8_SINT , GraphicsFormatR16_UINT , GraphicsFormatR16_SINT ,
  GraphicsFormatR16_SFLOAT , GraphicsFormatR16G16_UINT , GraphicsFormatR16G16_SINT , GraphicsFormatR16G16_SFLOAT ,
  GraphicsFormatR16G16B16_UINT , GraphicsFormatR16G16B16_SINT , GraphicsFormatR16G16B16_SFLOAT , GraphicsFormatR16G16B16A16_UINT ,
  GraphicsFormatR16G16B16A16_SINT , GraphicsFormatR16G16B16A16_SFLOAT , GraphicsFormatR5G6B5_UNORM_PACK16 , GraphicsFormatETC1_R8G8B8_UNORM ,
  GraphicsFormatETC2_R8G8B8_UNORM , GraphicsFormatETC2_R8G8B8A1_UNORM , GraphicsFormatETC2_R8G8B8A8_UNORM , GraphicsFormatBC2_UNORM ,
  GraphicsFormatBC3_UNORM , GraphicsFormatPVRTC1_RGB_2BPP , GraphicsFormatPVRTC1_RGB_4BPP , GraphicsFormatPVRTC1_RGBA_2BPP ,
  GraphicsFormatPVRTC1_RGBA_4BPP , GraphicsFormatPVRTC2_RGBA_2BPP , GraphicsFormatPVRTC2_RGBA_4BPP , GraphicsFormatATC_RGB ,
  GraphicsFormatATC_RGBA_EXPLICIT_ALPHA , GraphicsFormatATC_RGBA_INTERPOLATED_ALPHA , GraphicsFormatD16_UNORM , GraphicsFormatD24_UNORM ,
  GraphicsFormatD32_SFLOAT , GraphicsFormatD24_UNORM_S8_UINT , GraphicsFormatS8_UINT , GraphicsFormatASTC_4x4_UNORM_BLOCK ,
  GraphicsFormatASTC_4x4_SRGB_BLOCK , GraphicsFormatASTC_5x4_UNORM_BLOCK , GraphicsFormatASTC_5x4_SRGB_BLOCK , GraphicsFormatASTC_5x5_UNORM_BLOCK ,
  GraphicsFormatASTC_5x5_SRGB_BLOCK , GraphicsFormatASTC_6x5_UNORM_BLOCK , GraphicsFormatASTC_6x5_SRGB_BLOCK , GraphicsFormatASTC_6x6_UNORM_BLOCK ,
  GraphicsFormatASTC_6x6_SRGB_BLOCK , GraphicsFormatASTC_8x5_UNORM_BLOCK , GraphicsFormatASTC_8x5_SRGB_BLOCK , GraphicsFormatASTC_8x6_UNORM_BLOCK ,
  GraphicsFormatASTC_8x6_SRGB_BLOCK , GraphicsFormatASTC_8x8_UNORM_BLOCK , GraphicsFormatASTC_8x8_SRGB_BLOCK , GraphicsFormatASTC_10x5_UNORM_BLOCK ,
  GraphicsFormatASTC_10x5_SRGB_BLOCK , GraphicsFormatASTC_10x6_UNORM_BLOCK , GraphicsFormatASTC_10x6_SRGB_BLOCK , GraphicsFormatASTC_10x8_UNORM_BLOCK ,
  GraphicsFormatASTC_10x8_SRGB_BLOCK , GraphicsFormatASTC_10x10_UNORM_BLOCK , GraphicsFormatASTC_10x10_SRGB_BLOCK , GraphicsFormatASTC_12x10_UNORM_BLOCK ,
  GraphicsFormatASTC_12x10_SRGB_BLOCK , GraphicsFormatASTC_12x12_UNORM_BLOCK , GraphicsFormatASTC_12x12_SRGB_BLOCK , GraphicsFormatALPHA1_LUMINANCE7_UNORM ,
  GraphicsFormatALPHA4_LUMINANCE4_UNORM , GraphicsFormatALPHA8_LUMINANCE8_UNORM , GraphicsFormatALPHALUMINANCE1_UNORM , GraphicsFormatALPHALUMINANCE2_UNORM ,
  GraphicsFormatALPHALUMINANCE4_UNORM , GraphicsFormatALPHALUMINANCE8_UNORM , GraphicsFormatA1R5G5B5_UNORM , GraphicsFormatR5G5B5A1_UNORM ,
  GraphicsFormatA4R4G4B4_UNORM , GraphicsFormatR4G4B4A4_UNORM , GraphicsFormatA8R8G8B8_UNORM , GraphicsFormatCLUT8_UINT ,
  GraphicsFormatCLUT4_UINT , GraphicsFormatCLUT2_UINT , GraphicsFormatCLUT1_UINT , GraphicsFormatR8_SNORM ,
  GraphicsFormatR32_UINT , GraphicsFormatR32_SINT , GraphicsFormatR32_SFLOAT , GraphicsFormatR8G8_SNORM ,
  GraphicsFormatR32G32_UINT , GraphicsFormatR32G32_SINT , GraphicsFormatR32G32_SFLOAT , GraphicsFormatR8G8B8_SNORM ,
  GraphicsFormatR32G32B32_UINT , GraphicsFormatR32G32B32_SINT , GraphicsFormatR32G32B32_SFLOAT , GraphicsFormatR8G8B8A8_SNORM ,
  GraphicsFormatR32G32B32A32_UINT , GraphicsFormatR32G32B32A32_SINT , GraphicsFormatR32G32B32A32_SFLOAT , GraphicsFormatR16_UNORM ,
  GraphicsFormatR16_SNORM , GraphicsFormatR16G16_UNORM , GraphicsFormatR16G16_SNORM , GraphicsFormatR16G16B16_UNORM ,
  GraphicsFormatR16G16B16_SNORM , GraphicsFormatR16G16B16A16_UNORM , GraphicsFormatR16G16B16A16_SNORM , GraphicsFormatETC2_R8G8B8_SRGB ,
  GraphicsFormatETC2_R8G8B8A1_SRGB , GraphicsFormatETC2_R8G8B8A8_SRGB , GraphicsFormatPVRTC1_SRGB_2BPP , GraphicsFormatPVRTC1_SRGB_4BPP ,
  GraphicsFormatPVRTC1_SRGBA_2BPP , GraphicsFormatPVRTC1_SRGBA_4BPP , GraphicsFormatPVRTC2_SRGBA_2BPP , GraphicsFormatPVRTC2_SRGBA_4BPP ,
  GraphicsFormatA8R8G8B8_UINT , GraphicsFormatA8R8G8B8_SINT , GraphicsFormatA16R16G16B16_UINT , GraphicsFormatA16R16G16B16_SINT ,
  GraphicsFormatA16R16G16B16_SFLOAT , GraphicsFormatA8R8G8B8_SNORM , GraphicsFormatA32R32G32B32_UINT , GraphicsFormatA32R32G32B32_SINT ,
  GraphicsFormatA32R32G32B32_SFLOAT , GraphicsFormatA16R16G16B16_UNORM , GraphicsFormatA16R16G16B16_SNORM , GraphicsFormatGlRangeBegin ,
  GraphicsFormatGlRangeEnd , GraphicsFormatR_DRW2D_PIXELFORMAT_ALPHA8 , GraphicsFormatR_DRW2D_PIXELFORMAT_LUM8 , GraphicsFormatR_DRW2D_PIXELFORMAT_AL17 ,
  GraphicsFormatR_DRW2D_PIXELFORMAT_AL44 , GraphicsFormatR_DRW2D_PIXELFORMAT_AL88 , GraphicsFormatR_DRW2D_PIXELFORMAT_AL1 , GraphicsFormatR_DRW2D_PIXELFORMAT_AL2 ,
  GraphicsFormatR_DRW2D_PIXELFORMAT_AL4 , GraphicsFormatR_DRW2D_PIXELFORMAT_AL8 , GraphicsFormatR_DRW2D_PIXELFORMAT_RGB565 , GraphicsFormatR_DRW2D_PIXELFORMAT_ARGB1555 ,
  GraphicsFormatR_DRW2D_PIXELFORMAT_RGBA5551 , GraphicsFormatR_DRW2D_PIXELFORMAT_ARGB4444 , GraphicsFormatR_DRW2D_PIXELFORMAT_RGBA4444 , GraphicsFormatR_DRW2D_PIXELFORMAT_ARGB8888 ,
  GraphicsFormatR_DRW2D_PIXELFORMAT_RGBA8888 , GraphicsFormatR_DRW2D_PIXELFORMAT_CLUT_8 , GraphicsFormatR_DRW2D_PIXELFORMAT_CLUT_4 , GraphicsFormatR_DRW2D_PIXELFORMAT_CLUT_2 ,
  GraphicsFormatR_DRW2D_PIXELFORMAT_CLUT_1 , GraphicsFormatFullRangeBegin , GraphicsFormatFullRangeEnd
}
 GraphicsFormat specifies format of graphics data used for example in textures and vertex attributes. More...
 
enum  GraphicsFormatFeature {
  GraphicsFormatFeatureRenderbuffer , GraphicsFormatFeatureSampledImage , GraphicsFormatFeatureSampledImageFilterLinear , GraphicsFormatFeatureColorAttachment ,
  GraphicsFormatFeatureColorAttachmentBlend , GraphicsFormatFeatureDepthStencilAttachment , GraphicsFormatFeatureBlitSource , GraphicsFormatFeatureBlitDestination ,
  GraphicsFormatFeatureVertexBuffer , GraphicsFormatFeatureUniformTexelBuffer , GraphicsFormatFeatureStorageTexelBuffer , GraphicsFormatFeatureStorageTexelBufferAtomic ,
  GraphicsFormatFeatureStorageImage , GraphicsFormatFeatureStorageImageAtomic , GraphicsFormatFeatureRenderbufferMask , GraphicsFormatFeatureTextureMask
}
 How GraphicsFormat is used. More...
 
enum  GraphicsPrimitiveType {
  GraphicsPrimitiveTypeInvalid , GraphicsPrimitiveTypePoints , GraphicsPrimitiveTypeLines , GraphicsPrimitiveTypeLineLoop ,
  GraphicsPrimitiveTypeLineStrip , GraphicsPrimitiveTypeTriangles , GraphicsPrimitiveTypeTriangleStrip , GraphicsPrimitiveTypeTriangleFan ,
  GraphicsPrimitiveTypePatches
}
 Enumeration for index buffer primitive type. More...
 
enum  GraphicsScalar { GraphicsScalarClearDepth , GraphicsScalarCameraNearPlane , GraphicsScalarCameraFarPlane , GraphicsScalarCount }
 List of active renderer scalars for fixed functionality. More...
 
enum  GraphicsStencilOperation {
  GraphicsStencilOperationKeep , GraphicsStencilOperationZero , GraphicsStencilOperationReplace , GraphicsStencilOperationIncrement ,
  GraphicsStencilOperationIncrementWrap , GraphicsStencilOperationDecrement , GraphicsStencilOperationDecrementWrap , GraphicsStencilOperationInvert
}
 Renderer stencil operations. More...
 
enum  HalfFloatTexture { HalfFloatTextureNone , HalfFloatTextureARB , HalfFloatTextureES3 , HalfFloatTextureES2Ext }
 Half float texture support code path in Renderer. More...
 
enum  HalfFloatVertexAttribute { HalfFloatVertexAttributeNone , HalfFloatVertexAttributeDefault , HalfFloatVertexAttributeOES }
 Half float vertex attribute code path in Renderer. More...
 
enum  ImageFlipAxis { FlipAxisNone , FlipAxisHorizontal , FlipAxisVertical , FlipAxisHorizontalAndVertical }
 Image axis to flip over. More...
 
enum  ImageResizeFilter { ResizeFilterNearestNeighbor , ResizeFilterBilinear , ResizeFilterWeightedAverage }
 Image resizing filter methods. More...
 
enum  IndexBufferType { IndexBufferTypeUInt16 , IndexBufferTypeUInt32 }
 List of available types available for index buffers. More...
 
enum class  InputMethodAction {
  Default , Go , Next , Search ,
  Send , Done
}
 Specifies the available input method actions. More...
 
enum  InputTranslation {
  TranslateNone , TranslatePointerToTouch , TranslateTouchToPointer , TranslatePointerToTouchPreserve ,
  TranslateTouchToPointerPreserve
}
 Enumeration to select translation of events. More...
 
enum class  InputType { Default , Numeric , Email , URL }
 The input type used by the input method listener. More...
 
enum  InvalidateFramebuffer { InvalidateFramebufferNone , InvalidateFramebufferARB , InvalidateFramebufferES3 , InvalidateFramebufferES2Ext }
 Framebuffer invalidation support code path in Renderer. More...
 
enum class  KeyMatchResult { NoMatch , Match , PartialMatch }
 Key matching result values. More...
 
enum class  KeyModifier : size_t {
  KeyModifier::Undefined , KeyModifier::CapsLock , KeyModifier::LeftShift , KeyModifier::RightShift ,
  KeyModifier::LeftControl , KeyModifier::RightControl , KeyModifier::LeftAlt , KeyModifier::RightAlt ,
  KeyModifier::LeftSuper , KeyModifier::RightSuper , KeyModifier::Shift , KeyModifier::Control ,
  KeyModifier::Alt , KeyModifier::Super
}
 Key modifier flags. You can set more than one modifier at a time for a KeyEvent. More...
 
enum class  KeyState { KeyState::Pressed , KeyState::Released }
 Indicates the states of a hardware key. More...
 
enum  KzbProgramType { KzbProgramTypeSeparate , KzbProgramTypeCombined }
 Internal enum that is used to describe the data in the kzb file. More...
 
enum  KzuExpressionValidatorBinaryArgumentType {
  KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_SOURCE , KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_TARGET , KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_SOURCE_REGISTER_0 , KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_CONSTANT_REGISTER_0 ,
  KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_TEMPORARY_REGISTER_0 , KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_DATA_SOURCE_REGISTER_0
}
 Expression argument type from binary data. More...
 
enum  KzuExpressionValidatorOperation : int16_t {
  KZU_EXPRESSION_VALIDATOR_OPERATION_WRITE , KZU_EXPRESSION_VALIDATOR_OPERATION_ADD , KZU_EXPRESSION_VALIDATOR_OPERATION_SUBTRACT , KZU_EXPRESSION_VALIDATOR_OPERATION_MULTIPLY ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_DIVIDE , KZU_EXPRESSION_VALIDATOR_OPERATION_MODULO , KZU_EXPRESSION_VALIDATOR_OPERATION_ABS , KZU_EXPRESSION_VALIDATOR_OPERATION_MIN ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_MAX , KZU_EXPRESSION_VALIDATOR_OPERATION_CEIL , KZU_EXPRESSION_VALIDATOR_OPERATION_FLOOR , KZU_EXPRESSION_VALIDATOR_OPERATION_ROUND ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_POW , KZU_EXPRESSION_VALIDATOR_OPERATION_SQRT , KZU_EXPRESSION_VALIDATOR_OPERATION_STEP , KZU_EXPRESSION_VALIDATOR_OPERATION_TO_BOOL ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_TO_INT , KZU_EXPRESSION_VALIDATOR_OPERATION_TO_FLOAT , KZU_EXPRESSION_VALIDATOR_OPERATION_TO_STRING , KZU_EXPRESSION_VALIDATOR_OPERATION_REMAINDER ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_CREATE_ROTATION , KZU_EXPRESSION_VALIDATOR_OPERATION_CREATE_ROTATION_X , KZU_EXPRESSION_VALIDATOR_OPERATION_CREATE_ROTATION_Y , KZU_EXPRESSION_VALIDATOR_OPERATION_CREATE_ROTATION_Z ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_ROTATE , KZU_EXPRESSION_VALIDATOR_OPERATION_ROTATE_X , KZU_EXPRESSION_VALIDATOR_OPERATION_ROTATE_Y , KZU_EXPRESSION_VALIDATOR_OPERATION_ROTATE_Z ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_EXTRACT_EULER_X , KZU_EXPRESSION_VALIDATOR_OPERATION_EXTRACT_EULER_Y , KZU_EXPRESSION_VALIDATOR_OPERATION_EXTRACT_EULER_Z , KZU_EXPRESSION_VALIDATOR_OPERATION_GET_CURRENT_VALUE ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_ACQUIRE , KZU_EXPRESSION_VALIDATOR_OPERATION_COMPARE_GREATER , KZU_EXPRESSION_VALIDATOR_OPERATION_COMPARE_GREATER_OR_EQUAL , KZU_EXPRESSION_VALIDATOR_OPERATION_COMPARE_LESS ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_COMPARE_LESS_OR_EQUAL , KZU_EXPRESSION_VALIDATOR_OPERATION_COMPARE_EQUAL , KZU_EXPRESSION_VALIDATOR_OPERATION_COMPARE_NOT_EQUAL , KZU_EXPRESSION_VALIDATOR_OPERATION_LOGICAL_AND ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_LOGICAL_OR , KZU_EXPRESSION_VALIDATOR_OPERATION_LOGICAL_NOT , KZU_EXPRESSION_VALIDATOR_OPERATION_TO_MATRIX3x3 , KZU_EXPRESSION_VALIDATOR_OPERATION_TO_MATRIX4x4 ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_TO_SRT2D , KZU_EXPRESSION_VALIDATOR_OPERATION_TO_SRT3D , KZU_EXPRESSION_VALIDATOR_OPERATION_SIN , KZU_EXPRESSION_VALIDATOR_OPERATION_COS ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_TAN , KZU_EXPRESSION_VALIDATOR_OPERATION_ASIN , KZU_EXPRESSION_VALIDATOR_OPERATION_ACOS , KZU_EXPRESSION_VALIDATOR_OPERATION_ATAN ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_ATAN2 , KZU_EXPRESSION_VALIDATOR_OPERATION_SINC , KZU_EXPRESSION_VALIDATOR_OPERATION_DOT , KZU_EXPRESSION_VALIDATOR_OPERATION_CROSS ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_INVERSE , KZU_EXPRESSION_VALIDATOR_OPERATION_GET_FIELD , KZU_EXPRESSION_VALIDATOR_OPERATION_SET_FIELD , KZU_EXPRESSION_VALIDATOR_OPERATION_TRANSFORM ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_CLAMP , KZU_EXPRESSION_VALIDATOR_OPERATION_MIX , KZU_EXPRESSION_VALIDATOR_OPERATION_LINEARSTEP , KZU_EXPRESSION_VALIDATOR_OPERATION_SMOOTHSTEP ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_SMOOTHERSTEP , KZU_EXPRESSION_VALIDATOR_OPERATION_GET_PROJECTION_CAMERA_WORLD_MATRIX , KZU_EXPRESSION_VALIDATOR_OPERATION_GET_CAMERA_WORLD_MATRIX , KZU_EXPRESSION_VALIDATOR_OPERATION_GET_WORLD_MATRIX ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_GET_NORMAL_MATRIX , KZU_EXPRESSION_VALIDATOR_OPERATION_GET_CAMERA_POSITION , KZU_EXPRESSION_VALIDATOR_OPERATION_GET_AMBIENT , KZU_EXPRESSION_VALIDATOR_OPERATION_TERNARY_CONDITIONAL ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_LINEAR_TO_SRGB , KZU_EXPRESSION_VALIDATOR_OPERATION_SRGB_TO_LINEAR , KZU_EXPRESSION_VALIDATOR_OPERATION_TRANSPOSE , KZU_EXPRESSION_VALIDATOR_OPERATION_PREMULTIPLY_COLOR ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_GET_VIEW_POSITION , KZU_EXPRESSION_VALIDATOR_OPERATION_SPLIT , KZU_EXPRESSION_VALIDATOR_OPERATION_EVALUATE , KZU_EXPRESSION_VALIDATOR_OPERATION_CREATE_ITERATOR ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_CREATE_VIEW , KZU_EXPRESSION_VALIDATOR_OPERATION_TO_COLOR4 , KZU_EXPRESSION_VALIDATOR_OPERATION_TO_VECTOR2 , KZU_EXPRESSION_VALIDATOR_OPERATION_TO_VECTOR3 ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_TO_VECTOR4 , KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_WIDTH , KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_HEIGHT , KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_SIZE ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_PIXEL_FORMAT , KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_ADDRESSING_MODE , KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_DEPTH_COMPARE_FUNCTION , KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_FILTER_MODE ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_MIPMAP_MODE , KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_ANISOTROPY_LEVEL , KZU_EXPRESSION_VALIDATOR_OPERATION_TEXTURE_GET_MULTISAMPLE_LEVEL , KZU_EXPRESSION_VALIDATOR_OPERATION_BITWISE_NOT ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_BITWISE_AND , KZU_EXPRESSION_VALIDATOR_OPERATION_BITWISE_OR , KZU_EXPRESSION_VALIDATOR_OPERATION_BITWISE_XOR , KZU_EXPRESSION_VALIDATOR_OPERATION_BITWISE_LEFT_SHIFT ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_BITWISE_RIGHT_SHIFT , KZU_EXPRESSION_VALIDATOR_OPERATION_HSL_TO_SRGB , KZU_EXPRESSION_VALIDATOR_OPERATION_SRGB_TO_HSL , KZU_EXPRESSION_VALIDATOR_OPERATION_SIGN ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_LENGTH , KZU_EXPRESSION_VALIDATOR_OPERATION_NORMALIZE , KZU_EXPRESSION_VALIDATOR_OPERATION_GET_ROW , KZU_EXPRESSION_VALIDATOR_OPERATION_SET_ROW ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_GET_COLUMN , KZU_EXPRESSION_VALIDATOR_OPERATION_SET_COLUMN , KZU_EXPRESSION_VALIDATOR_OPERATION_CONTINUE_IF , KZU_EXPRESSION_VALIDATOR_OPERATION_GET_CAMERA_NORMAL_MATRIX ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_STRING_FORMAT , KZU_EXPRESSION_VALIDATOR_OPERATION_APPEND_RANGE , KZU_EXPRESSION_VALIDATOR_OPERATION_POSITION_CONSTRAINT , KZU_EXPRESSION_VALIDATOR_OPERATION_ORIENTATION_CONSTRAINT ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_LOOK_AT_CONSTRAINT , KZU_EXPRESSION_VALIDATOR_OPERATION_REVERSED_LOOK_AT_CONSTRAINT , KZU_EXPRESSION_VALIDATOR_OPERATION_REVERSED_CYLINDRICAL_LOOK_AT_CONSTRAINT , KZU_EXPRESSION_VALIDATOR_OPERATION_PROCESSOR ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_PROCESSOR_0 , KZU_EXPRESSION_VALIDATOR_OPERATION_PROCESSOR_1 , KZU_EXPRESSION_VALIDATOR_OPERATION_PROCESSOR_2 , KZU_EXPRESSION_VALIDATOR_OPERATION_PROCESSOR_3 ,
  KZU_EXPRESSION_VALIDATOR_OPERATION_INVALID
}
 Expression operation. More...
 
enum  KzuPropertyBinaryTargetAttribute {
  KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION_X , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION_Y , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION_Z , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE_X ,
  KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE_Y , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE_Z , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION_Z , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION_Y ,
  KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION_X , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_R , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_G ,
  KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_B , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_A , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_X , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_Y ,
  KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_Z , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_W , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE , KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION ,
  KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION
}
 Binding property field (binary file). More...
 
enum  KzuTimeLineEntryPlaybackMode { KZU_TIME_LINE_ENTRY_PLAYBACK_MODE_NORMAL , KZU_TIME_LINE_ENTRY_PLAYBACK_MODE_REVERSE , KZU_TIME_LINE_ENTRY_PLAYBACK_MODE_PINGPONG }
 Playback type of the timeline. More...
 
enum  KzuViewportCoordinateType { KZU_VIEWPORT_COORDINATE_ABSOLUTE , KZU_VIEWPORT_COORDINATE_RELATIVE }
 Enumeration for viewport coordinate unit type (exact pixel coordinates / percentages from window) More...
 
enum class  LogicalKey {
  LogicalKey::Unknown , LogicalKey::Number0 , LogicalKey::Number1 , LogicalKey::Number2 ,
  LogicalKey::Number3 , LogicalKey::Number4 , LogicalKey::Number5 , LogicalKey::Number6 ,
  LogicalKey::Number7 , LogicalKey::Number8 , LogicalKey::Number9 , LogicalKey::Comma ,
  LogicalKey::Period , LogicalKey::Semicolon , LogicalKey::Pipe , LogicalKey::Quote ,
  LogicalKey::DecimalSeparator , LogicalKey::ThousandsSeparator , LogicalKey::A , LogicalKey::B ,
  LogicalKey::C , LogicalKey::D , LogicalKey::E , LogicalKey::F ,
  LogicalKey::G , LogicalKey::H , LogicalKey::I , LogicalKey::J ,
  LogicalKey::K , LogicalKey::L , LogicalKey::M , LogicalKey::N ,
  LogicalKey::O , LogicalKey::P , LogicalKey::Q , LogicalKey::R ,
  LogicalKey::S , LogicalKey::T , LogicalKey::U , LogicalKey::V ,
  LogicalKey::W , LogicalKey::X , LogicalKey::Y , LogicalKey::Z ,
  LogicalKey::Space , LogicalKey::Backspace , LogicalKey::Enter , LogicalKey::Tab ,
  LogicalKey::BackTab , LogicalKey::Escape , LogicalKey::CapsLock , LogicalKey::NumLock ,
  LogicalKey::PrintScreen , LogicalKey::ScrollLock , LogicalKey::Break , LogicalKey::Insert ,
  LogicalKey::Delete , LogicalKey::Home , LogicalKey::End , LogicalKey::PageUp ,
  LogicalKey::PageDown , LogicalKey::Plus , LogicalKey::Minus , LogicalKey::Multiply ,
  LogicalKey::Divide , LogicalKey::ArrowUp , LogicalKey::ArrowDown , LogicalKey::ArrowLeft ,
  LogicalKey::ArrowRight , LogicalKey::Numpad0 , LogicalKey::Numpad1 , LogicalKey::Numpad2 ,
  LogicalKey::Numpad3 , LogicalKey::Numpad4 , LogicalKey::Numpad5 , LogicalKey::Numpad6 ,
  LogicalKey::Numpad7 , LogicalKey::Numpad8 , LogicalKey::Numpad9 , LogicalKey::NumpadDivide ,
  LogicalKey::NumpadMultiply , LogicalKey::NumpadPlus , LogicalKey::NumpadMinus , LogicalKey::NumpadComma ,
  LogicalKey::NumpadEnter , LogicalKey::F1 , LogicalKey::F2 , LogicalKey::F3 ,
  LogicalKey::F4 , LogicalKey::F5 , LogicalKey::F6 , LogicalKey::F7 ,
  LogicalKey::F8 , LogicalKey::F9 , LogicalKey::F10 , LogicalKey::F11 ,
  LogicalKey::F12 , LogicalKey::VolumeUp , LogicalKey::VolumeDown , LogicalKey::Softkey1 ,
  LogicalKey::Softkey2 , LogicalKey::Softkey3 , LogicalKey::Softkey4 , LogicalKey::Shift ,
  LogicalKey::Control , LogicalKey::Alt , LogicalKey::Super , LogicalKey::Menu ,
  LogicalKey::LeftAlt , LogicalKey::LeftControl , LogicalKey::LeftShift , LogicalKey::LeftSuper ,
  LogicalKey::RightAlt , LogicalKey::RightControl , LogicalKey::RightShift , LogicalKey::RightSuper ,
  LogicalKey::ButtonA , LogicalKey::ButtonB , LogicalKey::ButtonC , LogicalKey::ButtonX ,
  LogicalKey::ButtonY , LogicalKey::ButtonZ , LogicalKey::ButtonL1 , LogicalKey::ButtonL2 ,
  LogicalKey::ButtonR1 , LogicalKey::ButtonR2 , LogicalKey::ButtonSelect , LogicalKey::ButtonStart ,
  LogicalKey::ButtonThumbL , LogicalKey::ButtonThumbR , LogicalKey::ButtonMode , LogicalKey::Max
}
 Platform independent key enumeration. More...
 
enum  LogLevel { LogLevelError , LogLevelWarning , LogLevelInfo , LogLevelTrace }
 The log levels. More...
 
enum class  MainLoopState { Running , Paused , Quitting }
 Enumeration for application states. More...
 
enum  MessageRouting { MessageRoutingTunneling , MessageRoutingBubbling , MessageRoutingTunnelingBubbling }
 Message routing modes. More...
 
enum class  MmapMode { Default , Lazy , Eager }
 Specifies the available methods for memory mapping files. More...
 
enum  Multisample {
  MultisampleNone , MultisampleARB , MultisampleES2NVidia , MultisampleES3 ,
  MultisampleES2Ext , MultisampleES2Img
}
 Multisample support code path in Renderer. More...
 
enum class  MultisampleCount {
  NoMSAA , MSAAx2 , MSAAx4 , MSAAx8 ,
  MSAAx16 , MSAAx32
}
 Specifies the available numbers of samples for multisample anti-aliasing (MSAA). More...
 
enum class  NavigationDirection : size_t {
  Up , Down , Left , Right ,
  Home , End , PageUp , PageDown
}
 Specifies the navigation directions supported by the manipulator. More...
 
enum class  PointerButton : size_t {
  PointerButton::Undefined , PointerButton::Left , PointerButton::Right , PointerButton::Mid ,
  PointerButton::Extended1 , PointerButton::Extended2
}
 Pointer device button identifiers. More...
 
enum class  PointerState {
  PointerState::Pressed , PointerState::Moved , PointerState::Dragged , PointerState::Released ,
  PointerState::Scrolled
}
 Indicates the states of a pointing device. More...
 
enum  ProgramBinary { ProgramBinaryNone , ProgramBinaryARB , ProgramBinaryES3 , ProgramBinaryES2Ext }
 Program binary support code path in Renderer. More...
 
enum  PropertyDataType {
  PropertyDataTypeFloat , PropertyDataTypeInt , PropertyDataTypeBool , PropertyDataTypeColor ,
  PropertyDataTypeVector2 , PropertyDataTypeVector3 , PropertyDataTypeVector4 , PropertyDataTypeMatrix3x3 ,
  PropertyDataTypeMatrix4x4 , PropertyDataTypeString , PropertyDataTypePointer , PropertyDataTypeResource ,
  PropertyDataTypeSRT2D , PropertyDataTypeSRT3D , PropertyDataTypeRange
}
 Enumeration of data types that can be stored as properties. More...
 
enum  PropertyField {
  PropertyFieldWhole , PropertyFieldTranslationX , PropertyFieldTranslationY , PropertyFieldTranslationZ ,
  PropertyFieldScaleX , PropertyFieldScaleY , PropertyFieldScaleZ , PropertyFieldRotationX ,
  PropertyFieldRotationY , PropertyFieldRotationZ , PropertyFieldColorR , PropertyFieldColorG ,
  PropertyFieldColorB , PropertyFieldColorA , PropertyFieldVectorX , PropertyFieldVectorY ,
  PropertyFieldVectorZ , PropertyFieldVectorW , PropertyFieldRotation
}
 Property field. More...
 
enum  PropertyNotificationReason { PropertyNotificationReasonChanged , PropertyNotificationReasonRemoved }
 Property notification reason. More...
 
enum  PropertyTypeChangeFlag {
  PropertyTypeChangeFlagFinalTransformation , PropertyTypeChangeFlagMeasure , PropertyTypeChangeFlagParentMeasure , PropertyTypeChangeFlagArrange ,
  PropertyTypeChangeFlagRender , PropertyTypeChangeFlagDraw , PropertyTypeChangeFlagConstraint
}
 Each property type can have one or more change flags that indicate the effects of changing the value of that property. More...
 
enum  PropertyValuePrecedence { PropertyValuePrecedenceClass , PropertyValuePrecedenceStyle , PropertyValuePrecedenceLocal }
 Property value precedence. More...
 
enum class  QnxChannelIDFlags : unsigned int {
  Default , Priority , Unblock , ThreadDeath ,
  Disconnect , NetMsg , SenderLen , CoIdDisconnect ,
  ReplyLen , AsyncNonblock , Async , Global ,
  Private , MsgPausing , UnblockTimer
}
 QNX channel ID flags. More...
 
enum  RendererState {
  RendererStateDepthTest , RendererStateCullFace , RendererStateBlend , RendererStateDepthWrite ,
  RendererStateStencilTest , RendererStateStencilWrite , RendererStateMultisample , RendererStateScissorTest ,
  RendererStateCoverageWrite , RendererStateCount
}
 Renderer state enumerations. More...
 
enum  RendererSupport {
  RendererSupportHalfFloatTextureFormatLinear , RendererSupportHalfFloatColorAttachment , RendererSupportNPOTTextureFilter , RendererSupportRenderToMipmapLevels ,
  RendererSupportDepth16Renderbuffer , RendererSupportDepth16Texture , RendererSupportDepth24Renderbuffer , RendererSupportDepth24Texture ,
  RendererSupportDepth24Stencil8Renderbuffer , RendererSupportDepth24Stencil8Texture , RendererSupportDepth32Renderbuffer , RendererSupportDepth32fRenderbuffer ,
  RendererSupportDepth32fTexture , RendererSupportStencil8Renderbuffer , RendererSupportStencil8Texture , RendererSupportExternalTexture ,
  RendererSupportTexture2DArray , RendererSupportTexture3D , RendererSupportTextureCubeMapArray , RendererSupportTextureMultisample2D ,
  RendererSupportTextureMultisample2DArray , RendererSupportTextureFilterAnisotropic , RendererSupportTextureSwizzle , RendererSupportTextureSwizzleComponent ,
  RendererSupportTextureMaximumLevel , RendererSupportSeamlessCubeMap , RendererSupportRGB8Renderbuffer , RendererSupportRG8Formats ,
  RendererSupportRGFormats , RendererSupportIntegerFormats , RendererSupportRGB8Texture , RendererSupportRGBA8Renderbuffer ,
  RendererSupportRGBA8Texture , RendererSupportDiscardFramebuffer , RendererSupportInvalidateFramebuffer , RendererSupportImplementationColorRead ,
  RendererSupportKHRDebug , RendererSupportShaderBinary , RendererSupportSRGB , RendererSupportSRGB8Texture ,
  RendererSupportSRGB8TexStorage , RendererSupportETC1NPOT , RendererSupport10_10_10_2VertexAttribute , RendererSupportDepthComparison ,
  RendererSupport32BitIndexBuffer , RendererSupportMapBufferRange , RendererSupportSNORMFormats , RendererSupportFloatTextureFormatLinear ,
  RendererSupportFloatColorAttachment , SupportTextureNorm16Formats , RendererSupportTextureMirrorClampToEdge , RendererSupportUnpackRowLength ,
  RendererSupportClearBuffer , RendererSupportKHRBlendEquationAdvanced , RendererSupportInstancing , RendererSupportGeometryShader ,
  RendererSupportTessellationShader , RendererSupportES30 , RendererSupportES31 , RendererSupportES32 ,
  RendererSupportCount
}
 List of optionally supported renderer features. More...
 
enum  RenderTargetMode { RenderTargetModeNone , RenderTargetModeInternal , RenderTargetModeExternal }
 RenderTarget mode for Texture. More...
 
enum  ShaderType {
  ShaderTypeInvalid , ShaderTypeVertex , ShaderTypeFragment , ShaderTypeGeometry ,
  ShaderTypeTessellationControl , ShaderTypeTessellationEvaluation
}
 List of shader types. More...
 
enum class  Slog2VerbosityLevel {
  Slog2Shutdown , Slog2Critical , Slog2Error , Slog2Warning ,
  Slog2Notice , Slog2Info , Slog2Debug1 , Slog2Debug2
}
 Slogger2 verbosity levels. More...
 
enum  SphereTessellationType { SphereTypeUvSphere , SphereTypeIcosphere , SphereTypeQuadSphere }
 Specifies the available sphere tessellation types. More...
 
enum class  SurfaceClientAPI { Unspecified , OpenGLES , OpenVG , OpenGL }
 Client graphics API for a surface. More...
 
enum class  SurfaceColorSpace { Legacy , Passthrough , sRGB }
 Color Spaces for a surface. More...
 
enum class  SwapBehavior { Unspecified , Copy , Exchange }
 
enum  TexStorage {
  TexStorageNone , TexStorageMultisampleARB , TexStorageARB , TexStorageES2Ext ,
  TexStorageES3 , TexStorageES31 , TexStorageES32
}
 Texture Storage support code path in Renderer. More...
 
enum class  TextKeyNavigationDirection { LeftToRight , RightToLeft }
 Key navigation directions. More...
 
enum  TextureType {
  TextureTypeTwoDimensional , TextureTypeTwoDimensionalArray , TextureTypeTwoDimensionalMultisample , TextureTypeTwoDimensionalMultisampleArray ,
  TextureTypeThreeDimensional , TextureTypeCubeMap , TextureTypeCubeMapArray , TextureTypeExternal ,
  TextureTypeCount , TextureTypeInvalid
}
 Texture type. More...
 
enum class  TouchPointState {
  TouchPointState::Undefined , TouchPointState::Pressed , TouchPointState::Stationary , TouchPointState::Moved ,
  TouchPointState::Released
}
 Indicates the states of a touch point. More...
 
enum class  TouchState { TouchState::Begin , TouchState::Update , TouchState::End }
 Indicates the states of touch events. More...
 
enum  WindowOrientation { LandscapeOrientation , PortraitOrientation }
 List of window orientations. More...
 
enum class  WindowStyle {
  Fixed , Resizable , Fullscreen , Borderless ,
  StudioPreview , Default
}
 Styles for a window. More...
 

Functions

optional< intacquireBlendModeRenderValue (AbstractPropertyType propertyType, Node *node, Brush &brush, Material &material)
 Specialized acquire of blend mode value.
 
optional< intacquireBlendModeRenderValue (AbstractPropertyType propertyType, Node *node, PropertyObject *object, Material &material)
 Acquires the blend mode value.
 
tuple< FontRuntimeSharedPtr, boolacquireFont (const FontRuntimeSharedPtr &runtimeFont, const Node &node)
 Use this function to check whether a runtimeFont uses the font file and font style required to draw text with the property values of the node.
 
FontRuntimeSharedPtr acquireFont (const Node &node)
 Gets a runtime font object.
 
void acquireResources (Domain *domain, Mesh::CreateInfo &createInfo)
 For each cluster in mesh create info, load material from materialURL, if set.
 
int acquireUniformLocation (Material &material, string_view name)
 Acquire uniform location from a material.
 
template<>
void ActivityStatusAnimationFinishedHandler::sendMessages< ActivityConcept::Status::Activating > (ActivityElement &activityElement)
 ActivityStatusAnimationFinishedHandler::sendMessages() specialization.
 
template<>
void ActivityStatusAnimationFinishedHandler::sendMessages< ActivityConcept::Status::Active > (ActivityElement &activityElement)
 ActivityStatusAnimationFinishedHandler::sendMessages() specialization.
 
template<>
void ActivityStatusAnimationFinishedHandler::sendMessages< ActivityConcept::Status::Deactivating > (ActivityElement &activityElement)
 ActivityStatusAnimationFinishedHandler::sendMessages() specialization.
 
template<>
void ActivityStatusAnimationFinishedHandler::sendMessages< ActivityConcept::Status::Inactive > (ActivityElement &activityElement)
 ActivityStatusAnimationFinishedHandler::sendMessages() specialization.
 
void addApplicationPausedEvent (EventQueue &queue)
 Adds an InputEvent with InputEvent::ApplicationPaused type to the queue.
 
void addApplicationSleepEvent (EventQueue &queue)
 Adds an InputEvent with InputEvent::ApplicationSleep type to the queue.
 
void addApplicationWakeupEvent (EventQueue &queue)
 Adds an InputEvent with InputEvent::ApplicationWakeup type to the queue.
 
void addKeyEvent (EventQueue &queue, size_t rawKeyCode, LogicalKey key, KeyModifier modifiers, KeyState state)
 Adds a KeyEvent with multiple key modifiers to the queue.
 
void addKeyRepeatEvent (EventQueue &queue, size_t rawKeyCode, LogicalKey key, KeyModifier modifiers, size_t repeatCount)
 Adds to the queue a KeyEvent with multiple key modifiers, KeyState::Pressed state, and key-press repeatCount.
 
void addPointerEvent (EventQueue &queue, int x, int y, PointerButton buttons, PointerState state, int scroll=0)
 Adds a PointerEvent to the queue.
 
void addSetHudDebugEvent (EventQueue &queue, bool onOff)
 Adds a HudDebugEvent to the queue.
 
void addSinglePointTouchEvent (EventQueue &queue, TouchState state, size_t id, TouchPointState pointState, float x, float y, float pressure=1.0f, float radius=1.0f)
 Adds a TouchEvent with one touch point to the queue.
 
void addToggleHudDebugEvent (EventQueue &queue)
 Adds an InputEvent with InputEvent::DebugToggleHud type to the queue.
 
void addTouchEvent (EventQueue &queue, TouchState state, const list< TouchEvent::TouchPoint > &points)
 Adds a TouchEvent with multiple touch points to the queue.
 
void addWindowClosedEvent (EventQueue &queue, NativeWindowHandle target)
 Adds a WindowEvent with InputEvent::WindowClosed type to the queue.
 
void addWindowFocusGainedEvent (EventQueue &queue, NativeWindowHandle target)
 Adds a WindowEvent with InputEvent::WindowFocusGained type to the queue.
 
void addWindowFocusLostEvent (EventQueue &queue, NativeWindowHandle target)
 Adds a WindowEvent with InputEvent::WindowFocusLost type to the queue.
 
void addWindowHiddenEvent (EventQueue &queue, NativeWindowHandle target)
 Adds a WindowEvent with InputEvent::WindowHidden type to the queue.
 
void addWindowOrientationChangedEvent (EventQueue &queue, NativeWindowHandle target, WindowOrientation orientation)
 Adds an OrientationChangedEvent to the queue.
 
void addWindowPlacementRequestEvent (EventQueue &queue, NativeWindowHandle target)
 Adds a WindowPlacementRequest to the queue.
 
void addWindowRedrawRequestEvent (EventQueue &queue, NativeWindowHandle target)
 Adds a WindowRedrawRequestEvent to the queue.
 
void addWindowResizedEvent (EventQueue &queue, NativeWindowHandle target, unsigned int width, unsigned int height)
 Adds a WindowResizedEvent to the queue.
 
void addWindowResizeRequestEvent (EventQueue &queue, NativeWindowHandle target, unsigned int width, unsigned int height)
 Adds a WindowResizeRequestEvent to the queue.
 
void addWindowResourceLostEvent (EventQueue &queue, NativeWindowHandle target)
 Adds a WindowEvent with InputEvent::WindowResourceLost type to the queue.
 
bool animationConcatenate (bool lhs, bool rhs)
 
SRTValue2D animationConcatenate (const SRTValue2D &lhs, const SRTValue2D &rhs)
 
SRTValue3D animationConcatenate (const SRTValue3D &lhs, const SRTValue3D &rhs)
 
template<typename T >
T animationConcatenate (const T &lhs, const T &rhs)
 
ResourceSharedPtr animationConcatenate (ResourceSharedPtr, ResourceSharedPtr rhs)
 
bool animationInterpolate (bool from, bool to, float phase)
 
Quaternion animationInterpolate (const Quaternion &from, const Quaternion &to, float phase)
 
QuaternionLongerPath animationInterpolate (const QuaternionLongerPath &from, const QuaternionLongerPath &to, float phase)
 
ResourceID animationInterpolate (const ResourceID &from, const ResourceID &to, float phase)
 
const ResourceSharedPtranimationInterpolate (const ResourceSharedPtr &from, const ResourceSharedPtr &to, float phase)
 
SRTValue2D animationInterpolate (const SRTValue2D &from, const SRTValue2D &to, float phase)
 
SRTValue3D animationInterpolate (const SRTValue3D &from, const SRTValue3D &to, float phase)
 
SRTValue3DLongerPath animationInterpolate (const SRTValue3DLongerPath &from, const SRTValue3DLongerPath &to, float phase)
 
string animationInterpolate (const string &from, const string &to, float phase)
 
template<typename T >
T animationInterpolate (const T &from, const T &to, float phase)
 
int animationInterpolate (int from, int to, float phase)
 
void appendSkipSystemInitialization (SystemProperties &systemProperties)
 Adds "-nosysinit" to the end of the system properties.
 
Matrix3x3 applyGeometryOffsetAndSize (const Matrix3x3 &transformation, Vector2 offset, Vector2 size)
 Applies offset and size to 3x3 transformation.
 
Matrix4x4 applyGeometryOffsetAndSize (const Matrix4x4 &transformation, Vector2 offset, Vector2 size)
 Applies offset and size of the target rectangle to 4x4 transformation.
 
Matrix3x3 applyGeometryTargetRectangle (const Matrix3x3 &transformation, const RectangleFloat &targetRectangle)
 Applies offset and size of the target rectangle to 3x3 transformation.
 
Matrix4x4 applyGeometryTargetRectangle (const Matrix4x4 &transformation, const RectangleFloat &targetRectangle)
 Applies offset and size of the target rectangle to 4x4 transformation.
 
KZ_NO_DISCARD int applyPlatformMmapMode (int flags)
 Apply chosen platform mmapMode strategy to mmap() flags.
 
void applyProperties (Object &object, const KzbMemoryParser::PropertyContainer &properties)
 Apply properties from a PropertyContainer to an Object.
 
template<typename TargetType , typename FieldType >
void assignFieldValue (TargetType &value, PropertyField field, FieldType fieldValue)
 Free function for setting a field of a value.
 
template<>
void assignFieldValue< ColorRGBA, float > (ColorRGBA &value, PropertyField field, float fieldValue)
 Specialization of assignFieldValue;.
 
template<>
void assignFieldValue< Matrix3x3, float > (Matrix3x3 &value, PropertyField field, float fieldValue)
 Specialization of assignFieldValue;.
 
template<>
void assignFieldValue< Matrix4x4, float > (Matrix4x4 &value, PropertyField field, float fieldValue)
 Specialization of assignFieldValue;.
 
template<>
void assignFieldValue< SRTValue2D, float > (SRTValue2D &value, PropertyField field, float fieldValue)
 Specialization of assignFieldValue;.
 
template<>
void assignFieldValue< SRTValue3D, float > (SRTValue3D &value, PropertyField field, float fieldValue)
 Specialization of assignFieldValue;.
 
template<>
void assignFieldValue< SRTValue3D, Quaternion > (SRTValue3D &value, PropertyField field, Quaternion fieldValue)
 Specialization of assignFieldValue;.
 
template<>
void assignFieldValue< Vector2, float > (Vector2 &value, PropertyField field, float fieldValue)
 Specialization of assignFieldValue;.
 
template<>
void assignFieldValue< Vector3, float > (Vector3 &value, PropertyField field, float fieldValue)
 Specialization of assignFieldValue;.
 
template<>
void assignFieldValue< Vector4, float > (Vector4 &value, PropertyField field, float fieldValue)
 Specialization of assignFieldValue;.
 
template<class T >
T::iterator begin (T &t)
 
PropertyTypeRegistry::const_iterator beginPropertyTypes ()
 Get iterator to the beginning of registry of all property types.
 
ColorRGBA bindingExpressionDivide (const ColorRGBA &lhs, const ColorRGBA &rhs)
 Color divide the expression way.
 
Matrix3x3 bindingExpressionDivide (const Matrix3x3 &lhs, const Matrix3x3 &rhs)
 Matrix3x3 divide the expression way.
 
Matrix4x4 bindingExpressionDivide (const Matrix4x4 &lhs, const Matrix4x4 &rhs)
 Matrix4x4 divide the expression way.
 
Vector2 bindingExpressionDivide (const Vector2 &lhs, const Vector2 &rhs)
 Vector2 divide the expression way.
 
Vector3 bindingExpressionDivide (const Vector3 &lhs, const Vector3 &rhs)
 Vector3 divide the expression way.
 
Vector4 bindingExpressionDivide (const Vector4 &lhs, const Vector4 &rhs)
 Vector4 divide the expression way.
 
float bindingExpressionDivide (float lhs, float rhs)
 Floating point divide the expression way.
 
int bindingExpressionDivide (int lhs, int rhs)
 Integer divide the expression way.
 
BindingExpressionFunction bindingExpressionFunctionFromOperation (KzuExpressionValidatorOperation operation)
 Converts expression validation operation to a binding expression function.
 
ColorRGBA bindingExpressionModulo (const ColorRGBA &lhs, const ColorRGBA &rhs)
 Color modulo the expression way.
 
Matrix3x3 bindingExpressionModulo (const Matrix3x3 &lhs, const Matrix3x3 &rhs)
 Matrix3x3 modulo the expression way.
 
Matrix4x4 bindingExpressionModulo (const Matrix4x4 &lhs, const Matrix4x4 &rhs)
 Matrix4x4 modulo the expression way.
 
Vector2 bindingExpressionModulo (const Vector2 &lhs, const Vector2 &rhs)
 Vector2 modulo the expression way.
 
Vector3 bindingExpressionModulo (const Vector3 &lhs, const Vector3 &rhs)
 Vector3 modulo the expression way.
 
Vector4 bindingExpressionModulo (const Vector4 &lhs, const Vector4 &rhs)
 Vector4 modulo the expression way.
 
float bindingExpressionModulo (float lhs, float rhs)
 Floating point modulo the expression way.
 
int bindingExpressionModulo (int lhs, int rhs)
 Integer modulo the expression way.
 
ColorRGBA bindingExpressionRemainder (const ColorRGBA &lhs, const ColorRGBA &rhs)
 Color remainder the expression way.
 
Matrix3x3 bindingExpressionRemainder (const Matrix3x3 &lhs, const Matrix3x3 &rhs)
 Vector3 remainder the expression way.
 
Matrix4x4 bindingExpressionRemainder (const Matrix4x4 &lhs, const Matrix4x4 &rhs)
 Matrix4x4 remainder the expression way.
 
Vector2 bindingExpressionRemainder (const Vector2 &lhs, const Vector2 &rhs)
 Vector2 remainder the expression way.
 
Vector3 bindingExpressionRemainder (const Vector3 &lhs, const Vector3 &rhs)
 Vector3 remainder the expression way.
 
Vector4 bindingExpressionRemainder (const Vector4 &lhs, const Vector4 &rhs)
 Vector4 remainder the expression way.
 
float bindingExpressionRemainder (float lhs, float rhs)
 Floating point remainder the expression way.
 
int bindingExpressionRemainder (int lhs, int rhs)
 Integer remainder the expression way.
 
ColorRGBA bindingFixedOperationGetAmbient (Node &node, const Material &material)
 Fixed operation to acquire ambient color.
 
Matrix4x4 bindingFixedOperationGetCameraNormalMatrix (RenderPass &renderPass, Node &node)
 Fixed operation to acquire camera normal matrix.
 
Vector3 bindingFixedOperationGetCameraPosition (RenderPass &renderPass)
 Fixed operation to acquire camera position vector.
 
Matrix4x4 bindingFixedOperationGetCameraWorldMatrix (RenderPass &renderPass, Node &node)
 Fixed operation to acquire camera world matrix.
 
Matrix4x4 bindingFixedOperationGetNormalMatrix (Node &node)
 Fixed operation to acquire normal matrix.
 
Matrix4x4 bindingFixedOperationGetProjectionCameraWorldMatrix (RenderPass &renderPass, Node &node)
 Fixed operation to acquire projection camera world matrix.
 
Vector4 bindingFixedOperationGetViewPosition (RenderPass &renderPass)
 Fixed operation to acquire homogeneous view position vector.
 
Matrix4x4 bindingFixedOperationGetWorldMatrix (Node &node)
 Fixed operation to acquire world matrix.
 
template<typename T >
bool bindingWriteObjectProperty (PropertyObjectSharedPtr object, const Variant &value, AbstractPropertyType propertyType, PropertyField field)
 Writes an object property.
 
Box calculateBoundingVolume (const Mesh::CreateInfo &createInfo)
 Calculates bounding box from mesh vertex data.
 
optional< Vector4calculateCameraViewPosition (Matrix4x4 projectionCameraMatrix)
 Calculates a homogeneous camera view position that you can use to calculate the view direction in a shader.
 
Vector3 calculateEulerAngles (const Quaternion &quaternion)
 Calculates Euler angles from a quaternion.
 
void calculateFrustumPlanes (const Matrix4x4 &cameraViewMatrix, const Matrix4x4 &projectionMatrix, Plane *frustumPlanes)
 Internal function for calculating frustum planes.
 
unsigned int calculateMipmapLevelCount (unsigned int width, unsigned int height)
 Calculates number of mipmap levels for provided image size.
 
KZ_NO_DISCARD Matrix4x4 calculateOrdinaryGLTargetTransformationMatrix (unsigned int width, unsigned int height) noexcept
 Calculates the ordinary target transformation matrix for GLGraphicsOutput.
 
Box calculateWorldSpaceAABB (const OrientedBoundingBox &orientedBoundingBox)
 Gets a minimum size world space axis-aligned bounding box that encloses this transformed box.
 
bool canNodeGetFocus (const Node &node)
 Returns whether a node can get the key focus.
 
BitmapImageUniquePtr captureCurrentFramebufferToImage (unsigned int width, unsigned int height, GraphicsFormat format)
 Capture the current framebuffer to an image.
 
BitmapImageUniquePtr captureScreenToImage (Renderer &renderer, unsigned int width, unsigned int height, GraphicsFormat format)
 Capture the screen (default framebuffer) to an image.
 
template<class T , size_t N>
const Tcbegin (const T(&array)[N])
 
template<class T >
T::const_iterator cbegin (T const &t)
 
template<class T , size_t N>
const Tcend (const T(&array)[N])
 
template<class T >
T::const_iterator cend (T const &t)
 
UrlContainer collectResourceUrls (const KzbMemoryParser::PropertyContainer &properties)
 Collects URLs of all property values of Resource type.
 
ResourceManager::UrlContainer collectResourceUrls (const Mesh::CreateInfo &createInfo)
 For each cluster in mesh create info, get material URL, if set.
 
void collectResourceUrls (const PrefabTemplate &prefabTemplate, const Node &node, ResourceManager::UrlContainer &urls)
 Collects URLs from all resource properties that are used by the nodes in a prefab template.
 
void collectResourceUrls (const PrefabTemplate &prefabTemplate, ResourceManager::UrlContainer &urls)
 Collects URLs from all resource properties that are used by the nodes in a prefab template.
 
void collectResourceUrls (const PrefabTemplateNode &prefabTemplateNode, ResourceManager::UrlContainer &urls)
 Collects URLs from all resource properties that are used by a prefab template node and its children.
 
void collectResourceUrls (const ResourceDictionary &resourceDictionary, ResourceManager::UrlContainer &urls)
 Collects the URLs from a resource dictionary.
 
void collectResourceUrls (ResourceManager *resourceManager, ResourceManager::UrlContainer &urls)
 Collects the URLs of all resources from all the binary directories that have been added to the resource manager.
 
void collectResourceUrls (ResourceManager *resourceManager, string_view hostname, ResourceManager::UrlContainer &urls)
 Collect resource urls from a named file.
 
KZ_DEPRECATED void collectResourceUrlsFromPrefabTemplateNodeResourceDictionaryUrls (ResourceManager *resourceManager, string_view prefabTemplateNodeUrls, ResourceManager::UrlContainer &urls)
 Collects the URLs of resources from the resource dictionaries of the prefab templates you specify.
 
void collectResourceUrlsFromPrefabTemplateUrl (ResourceManager *resourceManager, string_view prefabTemplateUrl, const Node &node, ResourceManager::UrlContainer &urls)
 Collects URLs from all resource properties that are used by the nodes in a prefab template.
 
void collectResourceUrlsFromPrefabTemplateUrl (ResourceManager *resourceManager, string_view prefabTemplateUrl, ResourceManager::UrlContainer &urls)
 Collects URLs from all resource properties that are used by the nodes in a prefab template.
 
void collectResourceUrlsFromStateManagersAndRenderPassPrefabs (const PrefabTemplate &prefabTemplate, const Node &node, ResourceManager::UrlContainer &urls)
 Looks up resource properties of type StateManager or RenderPassPrefab in the nodes of a prefab template.
 
void collectResourceUrlsFromStateManagersAndRenderPassPrefabs (const PrefabTemplate &prefabTemplate, ResourceManager::UrlContainer &urls)
 Looks up resource properties of type StateManager or RenderPassPrefab in the nodes of a prefab template.
 
CompositionRequirements combineCompositionRequirements (const CompositionRequirements &lhs, const CompositionRequirements &rhs)
 Merge two composition requirements together.
 
ColorRGBA componentAbs (ColorRGBA v)
 Calculates component-wise absolute value for all elements and returns the resulting color.
 
Vector2 componentAbs (Vector2 v)
 Calculates component-wise absolute value for all elements and returns resulting vector.
 
Vector3 componentAbs (Vector3 v)
 Calculates component-wise absolute value for all elements and returns resulting vector.
 
Vector4 componentAbs (Vector4 v)
 Calculates component-wise absolute value for all elements and returns resulting vector.
 
ColorRGBA componentAdd (ColorRGBA v, float scalar)
 Adds a value to all color elements and returns the resulting color.
 
Vector2 componentAdd (Vector2 v, float scalar)
 Adds a value to all elements of a vector and returns the result.
 
Vector3 componentAdd (Vector3 v, float scalar)
 Adds a value to all elements of a vector and returns the result.
 
Vector4 componentAdd (Vector4 v, float scalar)
 Adds a value to all elements of a vector and returns the result.
 
bool componentAllGreaterThan (Vector2 a, Vector2 b)
 Returns whether each component of the first vector is greater than the corresponding component of the second vector.
 
bool componentAllGreaterThan (Vector3 a, Vector3 b)
 Returns whether each component of the first vector is greater than the corresponding component of the second vector.
 
bool componentAllGreaterThan (Vector4 a, Vector4 b)
 Returns whether each component of the first vector is greater than the corresponding component of the second vector.
 
bool componentAllGreaterThanOrEqual (Vector2 a, Vector2 b)
 Returns whether each component of the first vector is greater than or equal to the corresponding component of the second vector.
 
bool componentAllGreaterThanOrEqual (Vector3 a, Vector3 b)
 Returns whether each component of the first vector is greater than or equal to the corresponding component of the second vector.
 
bool componentAllGreaterThanOrEqual (Vector4 a, Vector4 b)
 Returns whether each component of the first vector is greater than or equal to the corresponding component of the second vector.
 
bool componentAllLessThan (Vector2 a, Vector2 b)
 Returns whether each component of the first vector is less than the corresponding component of the second vector.
 
bool componentAllLessThan (Vector3 a, Vector3 b)
 Returns whether each component of the first vector is less than the corresponding component of the second vector.
 
bool componentAllLessThan (Vector4 a, Vector4 b)
 Returns whether each component of the first vector is less than the corresponding component of the second vector.
 
bool componentAllLessThanOrEqual (Vector2 a, Vector2 b)
 Returns whether each component of the first vector is less than or equal to the corresponding component of the second vector.
 
bool componentAllLessThanOrEqual (Vector3 a, Vector3 b)
 Returns whether each component of the first vector is less than or equal to the corresponding component of the second vector.
 
bool componentAllLessThanOrEqual (Vector4 a, Vector4 b)
 Returns whether each component of the first vector is less than or equal to the corresponding component of the second vector.
 
ColorRGBA componentCeil (ColorRGBA v)
 Calculates component-wise ceil value for all elements and returns the resulting color.
 
Vector2 componentCeil (Vector2 v)
 Calculates component-wise ceil value for all elements and returns resulting vector.
 
Vector3 componentCeil (Vector3 v)
 Calculates component-wise ceil value for all elements and returns resulting vector.
 
Vector4 componentCeil (Vector4 v)
 Calculates component-wise ceil value for all elements and returns resulting vector.
 
ColorRGBA componentFloor (ColorRGBA v)
 Calculates component-wise floor value for all elements and returns the resulting color.
 
Vector2 componentFloor (Vector2 v)
 Calculates component-wise floor value for all elements and returns resulting vector.
 
Vector3 componentFloor (Vector3 v)
 Calculates component-wise floor value for all elements and returns resulting vector.
 
Vector4 componentFloor (Vector4 v)
 Calculates component-wise floor value for all elements and returns resulting vector.
 
ColorRGBA componentRound (ColorRGBA v)
 Calculates component-wise rounded value for all elements and returns the resulting color.
 
Vector2 componentRound (Vector2 v)
 Calculates component-wise rounded value for all elements and returns resulting vector.
 
Vector3 componentRound (Vector3 v)
 Calculates component-wise rounded value for all elements and returns resulting vector.
 
Vector4 componentRound (Vector4 v)
 Calculates component-wise rounded value for all elements and returns resulting vector.
 
ColorRGBA componentSqrt (ColorRGBA v)
 Calculates component-wise square root all elements and returns the resulting color.
 
Vector2 componentSqrt (Vector2 v)
 Calculates component-wise square root all elements and returns resulting vector.
 
Vector3 componentSqrt (Vector3 v)
 Calculates component-wise square root all elements and returns resulting vector.
 
Vector4 componentSqrt (Vector4 v)
 Calculates component-wise square root all elements and returns resulting vector.
 
ColorRGBA componentSubtract (ColorRGBA v, float scalar)
 Subtracts a value from all color elements and returns the resulting color.
 
Vector2 componentSubtract (Vector2 v, float scalar)
 Subtracts a value from all elements of a vector and returns the result.
 
Vector3 componentSubtract (Vector3 v, float scalar)
 Subtracts a value from all elements of a vector and returns the result.
 
Vector4 componentSubtract (Vector4 v, float scalar)
 Subtracts a value from all elements of a vector and returns the result.
 
template<typename T >
T componentWiseClamp (const T &value, const T &minvalue, const T &maxvalue)
 Clamps all vector fields between the given minimum and the maximum values.
 
ColorRGBA componentWiseDivide (ColorRGBA v1, ColorRGBA v2)
 Divides component-wise all color elements and returns the resulting color.
 
Matrix3x3 componentWiseDivide (const Matrix3x3 &m1, const Matrix3x3 &m2)
 Divides matrix components component-wise and returns the resulting matrix.
 
Matrix4x4 componentWiseDivide (const Matrix4x4 &m1, const Matrix4x4 &m2)
 Divides matrix components component-wise and returns the resulting matrix.
 
Vector2 componentWiseDivide (Vector2 v1, Vector2 v2)
 Divides all vector elements component-wise and returns the resulting vector.
 
Vector3 componentWiseDivide (Vector3 v1, Vector3 v2)
 Divides component-wise all vector elements and returns the resulting vector.
 
Vector4 componentWiseDivide (Vector4 v1, Vector4 v2)
 Divides component-wise all vector elements and returns the resulting vector.
 
ColorRGBA componentWiseMax (ColorRGBA v1, ColorRGBA v2)
 Calculates component-wise maximum for all color elements and returns the resulting color.
 
Matrix3x3 componentWiseMax (Matrix3x3 v1, Matrix3x3 v2)
 Calculates the component-wise maximum for all matrix elements and returns the resulting matrix.
 
Matrix4x4 componentWiseMax (Matrix4x4 v1, Matrix4x4 v2)
 Calculates the component-wise maximum for all matrix elements and returns the resulting matrix.
 
Vector2 componentWiseMax (Vector2 v1, Vector2 v2)
 Calculates the component-wise maximum for all vector elements and returns the resulting vector.
 
Vector3 componentWiseMax (Vector3 v1, Vector3 v2)
 Calculates the component-wise maximum for all vector elements and returns the resulting vector.
 
Vector4 componentWiseMax (Vector4 v1, Vector4 v2)
 Calculates the component-wise maximum for all vector elements and returns the resulting vector.
 
ColorRGBA componentWiseMin (ColorRGBA v1, ColorRGBA v2)
 Calculates component-wise minimum for all color elements and returns the resulting color.
 
Matrix3x3 componentWiseMin (Matrix3x3 v1, Matrix3x3 v2)
 Calculates the component-wise minimum for all matrix elements and returns the resulting matrix.
 
Matrix4x4 componentWiseMin (Matrix4x4 v1, Matrix4x4 v2)
 Calculates the component-wise minimum for all matrix elements and returns the resulting matrix.
 
Vector2 componentWiseMin (Vector2 v1, Vector2 v2)
 Calculates the component-wise minimum for all vector elements and returns the resulting vector.
 
Vector3 componentWiseMin (Vector3 v1, Vector3 v2)
 Calculates the component-wise minimum for all vector elements and returns the resulting vector.
 
Vector4 componentWiseMin (Vector4 v1, Vector4 v2)
 Calculates the component-wise minimum for all vector elements and returns the resulting vector.
 
ColorRGBA componentWiseMultiply (ColorRGBA v1, ColorRGBA v2)
 Multiplies component-wise all color elements and returns the resulting color.
 
Matrix3x3 componentWiseMultiply (const Matrix3x3 &m1, const Matrix3x3 &m2)
 Multiplies matrix components component-wise and returns the resulting matrix.
 
Matrix4x4 componentWiseMultiply (const Matrix4x4 &m1, const Matrix4x4 &m2)
 Multiplies matrix components component-wise and returns the resulting matrix.
 
Quaternion componentWiseMultiply (const Quaternion &q1, const Quaternion &q2)
 Multiplies quaternion components component-wise and returns the resulting quaternion.
 
Vector2 componentWiseMultiply (Vector2 v1, Vector2 v2)
 Multiplies all vector elements component-wise and returns the resulting vector.
 
Vector3 componentWiseMultiply (Vector3 v1, Vector3 v2)
 Multiplies component-wise all vector elements and returns the resulting vector.
 
Vector4 componentWiseMultiply (Vector4 v1, Vector4 v2)
 Multiplies component-wise all vector elements and returns the resulting vector.
 
ColorRGBA componentWiseRemainder (ColorRGBA v1, ColorRGBA v2)
 Calculates component-wise the remainder for all color elements and returns the resulting color.
 
Vector2 componentWiseRemainder (Vector2 v1, Vector2 v2)
 Calculates component-wise the remainder for all vector elements and returns the resulting vector.
 
Vector3 componentWiseRemainder (Vector3 v1, Vector3 v2)
 Calculates component-wise the remainder for all vector elements and returns the resulting vector.
 
Vector4 componentWiseRemainder (Vector4 v1, Vector4 v2)
 Calculates component-wise the remainder for all vector elements and returns the resulting vector.
 
template<typename T , size_t Size, typename U >
bool contains (const array< T, Size > &c, const U &value)
 
template<typename T , typename A , typename U >
bool contains (const vector< T, A > &c, const U &value)
 
Timeline::DirectionBehavior convert (KzuTimeLineEntryPlaybackMode mode)
 
KzuTimeLineEntryPlaybackMode convert (Timeline::DirectionBehavior behavior)
 
wstring convertUTF8ToWideChar (string_view utf8)
 Converts a given UTF-8 string view into a Win32-compatible wide character string.
 
Win32String convertUTF8ToWin32 (string_view utf8)
 
string convertWideCharToUTF8 (wstring_view wchar)
 Converts a given Win32-compatible wide character string view into a UTF-8 string.
 
Win32String convertWideCharToWin32 (wstring_view wchar)
 
string convertWin32ToUTF8 (Win32StringView win32)
 
wstring convertWin32ToWideChar (Win32StringView win32)
 
template<class T >
T::const_reverse_iterator crbegin (T const &t)
 
template<typename T >
Variant createDataObjectVariant (const T &value)
 Creates a new Variant from data object value.
 
Variant createDataObjectVariant (double value)
 createDataObjectVariant() overload.
 
optional< BindingLoadInfocreateDefaultRenderValueBinding (Domain *domain, optional< AbstractPropertyType > propertyType, string_view renderValueName, PropertyDataType dataType, unsigned arraySize, ShaderProgram::UniformTransformation transformation)
 Creates a default binding for a given render value.
 
KZ_NO_DISCARD EGLContext createEGLContextForClientVersion (const EGLDisplay &eglDisplay, const EGLConfig &eglConfig, EGLContextClientSelection contextClientSelection)
 Creates an EGL context for a given context client version.
 
Matrix4x4 createRelativeOrthogonalProjection (float near, float far, Matrix4x4::FieldOfViewType fovType, float orthoSize, float aspectRatio)
 Creates an orthogonal projection matrix for a symmetrical viewing volume.
 
TextureSharedPtr createTextureFromMemory (Domain *domain, unsigned int width, unsigned int height, GraphicsFormat sourceFormat, const void *data, GraphicsFormat destinationFormat, string_view name)
 Loads a new image from memory and creates a texture out of it.
 
template<class T >
T::const_reverse_iterator crend (T const &t)
 
Vector3 crossProduct (Vector3 v1, Vector3 v2)
 Calculates the cross product of two vectors.
 
Vector4 crossProduct (Vector4 v1, Vector4 v2)
 Calculates the cross product of two vectors.
 
constexpr float degreesToRadians (float angleInDegrees)
 Converts degrees to radians.
 
void doListBoxArrange (Node2D &node)
 
void doListBoxArrange (Node3D &node)
 
float dotProduct (ColorRGBA v1, ColorRGBA v2)
 Calculates the dot product of two colors.
 
float dotProduct (const Quaternion &q1, const Quaternion &q2)
 Calculates the dot product of two quaternions.
 
float dotProduct (Vector2 v1, Vector2 v2)
 Calculates the dot product of two vectors.
 
float dotProduct (Vector3 v1, Vector3 v2)
 Calculates the dot product of two vectors.
 
float dotProduct (Vector4 v1, Vector4 v2)
 Calculates the dot product of two vectors.
 
timespec durationToTimespec (chrono::nanoseconds duration)
 Converts C++ nanoseconds to POSIX native nanosecond format.
 
timeval durationToTimeval (chrono::microseconds duration)
 Converts C++ microsecond to POSIX native microsecond format.
 
template<class T >
T::iterator end (T &t)
 
PropertyTypeRegistry::const_iterator endPropertyTypes ()
 Get iterator to the end of registry of all property types.
 
template<typename T , typename A , typename U >
void erase (vector< T, A > &c, const U &value)
 
template<class K , class T , class H , class P , class A , class Predicate >
void erase_if (unordered_map< K, T, H, P, A > &c, Predicate pred)
 
template<typename T , typename A , typename U >
void erase_if (vector< T, A > &c, const U &predicate)
 
bool expressionOperationWrite (BindingExpressionOpCodeParameters &params)
 Execute write operation.
 
Matrix3x3 extract3x3 (const Matrix4x4 &matrix)
 Extracts the 3x3 rotation and scaling part of a matrix.
 
void extractExpressionField (Variant &outputRegister, const Variant &inputRegister, PropertyField field)
 Reads a field from an input register and writes it to the output register.
 
bool extractSRT (const Matrix3x3 &matrix, Vector2 &scale, float &rotationInRadians, Vector2 &translation)
 Extracts scale, rotation and translation information from a matrix.
 
bool extractSRT (const Matrix4x4 &matrix, Vector3 &scale, Vector3 &rotationInRadians, Vector3 &translation)
 Extracts from a matrix the scale, rotation, and translation information.
 
FocusScopefindAncestorScopeForNode (const Node &node)
 Returns the ancestor focus scope of the node that you pass as an argument.
 
template<typename Predicate >
FocusScopefindAncestorScopeIf (Node &first, Node &last, Predicate predicate)
 Find the first ancestor scope in the [first node, last node) range, for which the predicate returns true.
 
template<typename Predicate >
FocusScopefindAncestorScopeIfNot (Node &first, Node &last, Predicate predicate)
 Find the first ancestor scope in the [first node, last node) range, for which the predicate returns false.
 
NodefindCommonParent (const Node &nodeA, const Node &nodeB)
 Gets first common parent from nodeA and nodeB, or null if not found.
 
string_view findConfigurationName (const SystemProperties &systemProperties, string_view defaultConfigurationName)
 Returns the tail of the first argument that starts with "-config=" or default configuration name if not found.
 
KZ_NO_DISCARD optional< EGLContextClientVersionfindEGLContextClientVersion (const EGLDisplay &eglDisplay, const ::EGLConfig eglConfig, const EGLContextClientSelection selection) noexcept
 Returns the correct EGL context client version based on EGLContextClientSelection.
 
KZ_NO_DISCARD optional< EGLContextClientVersionfindEGLContextClientVersion (const EGLDisplay &eglDisplay, const span< ::EGLConfig > eglConfigs, const EGLContextClientSelection selection) noexcept
 Returns the correct EGL context client version based on EGLContextClientSelection.
 
FocusFencefindFenceForNode (const Node &node)
 Returns the focus fence of the given node that you pass as an argument.
 
KZ_NO_DISCARD::EGLConfig findFirstMatchEGLConfig (const EGLDisplay &eglDisplay, const EGLCapabilities &requiredCapabilities) noexcept
 Finds the first EGL configuration that matches the capabilities, returns no config if no matches are found.
 
optional< GraphicsFormatfindGraphicsFormatByName (string_view formatName)
 Returns GraphicsFormat given its name as a human readable string.
 
KZ_NO_DISCARD optional< EGLContextClientVersionfindHighestContextClientVersion (const EGLDisplay &eglDisplay, const ::EGLConfig eglConfig) noexcept
 Returns the highest context client version supported by an EGL configuration.
 
KZ_NO_DISCARD optional< EGLContextClientVersionfindHighestContextClientVersion (const EGLDisplay &eglDisplay, const span< ::EGLConfig > eglConfigs) noexcept
 Returns the highest context client version supported by at least one EGL configuration.
 
template<typename Function >
OverlayScopefindInputPropagationOverlayIf (OverlayScope *overlayScope, Function predicate)
 Finds the overlay focus scope that is the overlayScope, or one of its preceding overlay focus scopes to which Kanzi lets the input propagate, for which the predicate function returns true.
 
OverlayScopefindOverlayScopeForNode (const Node &node)
 Returns the overlay focus scope to which the node that you pass in this function belongs.
 
template<typename Type >
shared_ptr< Type > findParent (const Node &node)
 Gets nearest parent of specified type.
 
FocusScopefindScopeForNode (const Node &node)
 Returns the focus scope of the node that you pass as an argument.
 
bool floatIsAlmostEqual (float valueA, float valueB)
 Check if two floats are approximately equal.
 
bool floatIsAlmostEqualAbsolute (float valueA, float valueB, float maxAbsoluteDifference)
 Check if two floats are equal up to a given difference.
 
bool floatIsAlmostEqualUlps (float valueA, float valueB, unsigned int maxUlps)
 Floating point helper methods.
 
constexpr bool floatIsEqual (float valueA, float valueB)
 Check if two floats are equal.
 
uint16_t floatToHalfFloat (float f)
 Converts float to 16 bits representing a half float.
 
constexpr unsigned int floatToUint (float value)
 Casts a float to unsigned int.
 
template<typename Function >
void forEachAncestorNodeInScope (const Node &node, const FocusScope *scope, Function function)
 Execute a function for every ancestor node of the node, until and including the focus scope node that is an ancestor of the node.
 
template<typename Function >
void forEachAncestorScope (Node &first, Node &last, Function function)
 Execute a function for every focus scope in the [first node, last node) range.
 
template<typename Function >
void forEachAncestorScopeOf (Node &node, Function function)
 Executes a function for every ancestor focus scope of the node, until and including the overlay focus scope node that owns the node.
 
from_chars_result from_chars (const char *first, const char *last, int &value, int base=10)
 Converts a character sequence to an integer value.
 
from_chars_result from_chars (const char *first, const char *last, unsigned int &value, int base=10)
 Converts a character sequence to an unsigned integer value.
 
from_chars_result from_chars (const char *first, const char *last, unsigned long &value, int base=10)
 Converts a character sequence to an unsigned long value.
 
from_chars_result from_chars (const char *first, const char *last, unsigned long long &value, int base=10)
 Converts a character sequence to an unsigned long long value.
 
Mesh::CreateInfo generateBox (Vector3 size, unsigned int subdivisions, bool useHalfFloat, bool generateNormals, bool generateTangents, bool insideOut, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for a box primitive mesh.
 
Mesh::CreateInfo generateBox (Vector3 size, unsigned int subdivisions, bool useHalfFloat, bool generateNormals, bool generateTangents, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for a box primitive mesh.
 
Mesh::CreateInfo generateCone (float bottomRadius, unsigned int bottomSegmentCount, float height, bool useHalfFloat, bool generateNormals, bool generateTangents, bool insideOut, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for a UV cone primitive mesh.
 
Mesh::CreateInfo generateCone (float bottomRadius, unsigned int bottomSegmentCount, float height, bool useHalfFloat, bool generateNormals, bool generateTangents, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for a UV cone primitive mesh.
 
Mesh::CreateInfo generateIcosphere (float radius, unsigned int subdivisions, bool useHalfFloat, bool generateNormals, bool generateTangents, bool insideOut, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for an icosphere primitive mesh.
 
Mesh::CreateInfo generateIcosphere (float radius, unsigned int subdivisions, bool useHalfFloat, bool generateNormals, bool generateTangents, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for an icosphere primitive mesh.
 
Mesh::CreateInfo generatePlane (float width, float height, unsigned int subdivisions, bool invertU, bool invertV, bool useHalfFloat, bool generateNormals, bool generateTangents, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for a plane primitive mesh.
 
Mesh::CreateInfo generateQuadsphere (float radius, unsigned int subdivisions, bool useHalfFloat, bool generateNormals, bool generateTangents, bool insideOut, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for a quad sphere primitive mesh.
 
Mesh::CreateInfo generateQuadsphere (float radius, unsigned int subdivisions, bool useHalfFloat, bool generateNormals, bool generateTangents, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for a quad sphere primitive mesh.
 
Mesh::CreateInfo generateSphere (float radius, unsigned int segmentCount, unsigned int rowCount, bool useHalfFloat, bool generateNormals, bool generateTangents, bool insideOut, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for a UV sphere primitive mesh.
 
Mesh::CreateInfo generateSphere (float radius, unsigned int segmentCount, unsigned int rowCount, bool useHalfFloat, bool generateNormals, bool generateTangents, MaterialSharedPtr material, string_view materialURL, GPUResource::MemoryType memoryType)
 Makes mesh create info for a UV sphere primitive mesh.
 
unsigned int getAttributeDimension (VertexAttribute::Semantic attribute)
 Gets the number of elements for a vertex attribute semantic.
 
unsigned int getBitCount (GraphicsDataType dataType)
 Return number of bits per one element of data type.
 
unsigned int getBitCount (GraphicsDataType dataType, unsigned int componentCount)
 Return number of bits per one element of data type.
 
unsigned int getBitsPerBlock (GraphicsFormat format)
 Returns number of bits per block of the specified format.
 
constexpr BlendEquationAdvanced getBlendEquationAdvanced (int blendMode)
 Gets the advanced blend equation.
 
constexpr BlendEquation getBlendEquationAlpha (int blendMode)
 Gets the alpha blend equation.
 
constexpr BlendEquation getBlendEquationColor (int blendMode)
 Gets the color blend equation.
 
unsigned int getByteCount (GraphicsDataType dataType)
 Return number of bytes per one element of data type.
 
unsigned int getByteCount (GraphicsDataType dataType, unsigned int dimension)
 Returns number of bytes for graphics data.
 
unsigned int getBytesPerBlock (GraphicsFormat format)
 Returns number of bytes per block of the specified format.
 
unsigned int getChannelCount (GraphicsFormat format)
 Returns number of unique color channels of the format.
 
constexpr float getCloseToZeroRange ()
 Returns the largest value of a floating point number which is considered as "almost zero".
 
GraphicsFormat getCommon (GraphicsFormat format1, GraphicsFormat format2)
 Returns a common superset of two formats, or GraphicsFormatNone if formats cannot be combined.
 
int getCompressedGLFormat (GraphicsFormat format)
 Returns the GL API internal format enumeration of the kanzi::Format.
 
unsigned int getDataSizeBytes (int width, int height, GraphicsFormat format)
 Returns data size in bytes for image with specified dimensions and format.
 
GraphicsDataType getDataType (GraphicsFormat format)
 Returns data type of the format.
 
GraphicsFormat getDefaultGraphicsFormatForColorSpace (SurfaceColorSpace space)
 Gets the default graphics format to represent a given surface color space.
 
float getDeterminant (const Matrix3x3 &matrix)
 Calculates the determinant of the matrix.
 
float getDeterminant (const Matrix4x4 &matrix)
 Calculates the determinant of a matrix.
 
float getDeterminant2x2 (const Matrix3x3 &matrix)
 Calculates the determinant of the 2X2 part of a matrix.
 
float getDeterminant3x3 (const Matrix4x4 &matrix)
 Calculates the determinant of the 3x3 part of a matrix.
 
constexpr BlendFactor getDstAlphaFactor (int blendMode)
 Gets the destination alpha factor.
 
constexpr BlendFactor getDstColorFactor (int blendMode)
 Gets the destination color factor.
 
KZ_NO_DISCARD::EGLConfig getEGLConfig (const EGLDisplay &eglDisplay, const EGLCapabilities &requiredCapabilities) noexcept
 Gets the EGL configuration matching with the graphics format ID, if specified, otherwise finds the first EGL configuration that matches the capabilities.
 
string getExpressionOperationName (KzuExpressionValidatorOperation operation)
 Gets a string representation of an expression validator operator.
 
unsigned int getFaceCount (TextureType type)
 Gets face count for a given texture type.
 
GraphicsFormat getFallback (GraphicsFormat format)
 Returns an alternative format which is potentially more widely supported.
 
ShaderProgram::FixedUniformFunction getFixedUniformFunction (string_view renderValueName)
 Gets a matching fixed uniform function for a fixed uniform.
 
ShaderProgram::FixedUniformFunction getFixedUniformFunction (string_view renderValueName, ShaderProgram::UniformTransformation transformation)
 Gets a matching fixed uniform function for a fixed uniform.
 
const ShaderProgram::FixedUniformFunctionInfogetFixedUniformFunctionInfo (ShaderProgram::FixedUniform uniform)
 Gets a matching fixed uniform function for a fixed uniform.
 
GeometrySharedPtr getFullScreenTriangleGeometry (Domain *domain)
 Gets a shared instance of full screen triangle.
 
unsigned int getGLTextureImageTarget (TextureType type, unsigned int face)
 
unsigned int getGLTextureTarget (TextureType type)
 
vector< size_t > getGraphemeClusters (string_view text)
 Returns the indices of the characters that start new grapheme clusters in the given text.
 
size_t getIndexTypeStride (IndexBufferType type)
 Returns the stride of a given index type.
 
optional< TimeIntervalgetIntersection (const TimeInterval &first, const TimeInterval &second)
 Gets intersection of two intervals.
 
bool getInvalidLightValue (Variant &value, AbstractPropertyType propertyType)
 Gets an 'invalid' value for a light that does not exist.
 
KANZI_JVM_API JniLibrarygetJniLibrary ()
 Gets a set of function pointers that represent the JNI library.
 
ConstByteSpan getKzbMagic ()
 Gets the kzb magic byte sequence.
 
Light::Type getLightTypeForCollectionName (string_view collectionName, AbstractPropertyType propertyType, string_view renderValueName)
 Returns the light type based on the collection name or, if collection name is empty, on the property type.
 
string getNodeListBindingSourcePath (const RenderPass &renderPass)
 Gets the input path for a render pass to use with a node list binding.
 
Vector3 getOrthogonalVector (Vector3 v)
 Finds a vector that is orthogonal to the given vector.
 
Quaternion getQuaternionField (const Variant &variant, PropertyField field)
 Gets a quaternion field from a variant.
 
optional< string > getRelativePath (const Node &targetNode, const Node &baseNode)
 Gets the relative path from base object node to target object node, or nullopt if path could not be found.
 
const NodegetRoot (const Node &node)
 Gets the root node of the node tree to which the node belongs.
 
NodegetRoot (Node &node)
 Gets the root node of the node tree to which the node belongs.
 
RenderPassgetRoot (RenderPass &renderPass)
 Gets the render pass of the graph render pass belongs to.
 
const bytegetRuntimeAssetData ()
 Gets runtime asset data.
 
size_t getRuntimeAssetDataSize ()
 Gets size of runtime asset data.
 
NodegetScopeFocusedNode (Node &node)
 Returns the last-focused node of the scope node.
 
constexpr BlendFactor getSrcAlphaFactor (int blendMode)
 Gets the source alpha factor.
 
constexpr BlendFactor getSrcColorFactor (int blendMode)
 Gets the source color factor.
 
GraphicsFormat getSRGBFormat (GraphicsFormat format)
 Returns an sRGB format that is compatible with the provided format.
 
uint32_t getSupportedKzbFormatVersion ()
 Gets the supported kzb format version.
 
float getTrace (const Matrix3x3 &matrix)
 Calculates the trace of a matrix.
 
float getTrace (const Matrix4x4 &matrix)
 Calculates the trace of a matrix.
 
unsigned int getTreeHeight (const Node &node)
 Gets tree height from the object node to the parent.
 
const bytegetUIAssetData ()
 Gets UI asset data.
 
size_t getUIAssetDataSize ()
 Gets size of UI asset data.
 
unsigned int getUniformElementCount (Material &material, string_view name)
 Get uniform element count from a material.
 
template<typename T >
Rectangle< TgetUnion (const Rectangle< T > &rectangle1, const Rectangle< T > &rectangle2)
 Calculates union of the two rectangles.
 
GeometrySharedPtr getUnitQuadGeometry (Domain *domain)
 Gets a shared instance of unit quad geometry.
 
Matrix3x3 getUnitQuadTargetTransformation (const RectangleFloat &targetRectangle)
 Gets the 3x3 transformation that maps the unit quad geometry to the target rectangle.
 
Matrix3x3 getUnitQuadTargetTransformation (Vector2 offset, Vector2 size)
 Gets the 3x3 transformation that maps the unit quad geometry to the target offset and size.
 
size_t getUtf8Length (string_view text)
 Returns the number of UTF-8 characters in the text.
 
size_t getUtf8NextWordbreakPosition (string_view text, size_t position)
 Gets the position of the next word break following the character position position.
 
size_t getUtf8NextWordbreakPosition (string_view text, size_t position, size_t words)
 Gets the position of the next word break following the character position position after the number of words words.
 
size_t getUtf8PreviousWordbreakPosition (string_view text, size_t position)
 Gets the position of the previous word break that precedes the character position position.
 
size_t getUtf8PreviousWordbreakPosition (string_view text, size_t position, size_t words)
 Gets the position of the next word break following the character position position after the number of words words.
 
pair< size_t, size_t > getUtf8WordBounds (string_view text, size_t position)
 Gets the character positions at the begin and end of the word to which the character at position position belongs.
 
size_t getUtf8WordCount (string_view text)
 Gets the number of words in a UTF-8 text string.
 
FixedString getVerboseDescription (ShaderProgram::CreateInfo::Status status)
 Returns human readable description for ShaderProgram CreateInfo status.
 
FixedString getVerboseDescription (Texture::CreateInfo::Status status)
 Returns human readable description for CreateInfo status.
 
template<typename TWrappedType >
shared_ptr< TWrappedTypegetWrappedEventSource (EventSourceSharedPtr eventSource)
 Returns the event source wrapper of TWrappedType type from the passed event source.
 
float halfFloatToFloat (uint16_t halfFloatNumber)
 Converts 16 bits representing a half float to a float.
 
void handleDefaultExceptions (JNIEnv *env)
 Handle the top level Java and native exceptions and rethrow via the JNI.
 
bool hasAliasedChannel (GraphicsFormat format)
 Indicates whether given format has an aliased color channel.
 
bool hasAlpha (GraphicsFormat format)
 Indicates whether given format has alpha channel.
 
bool hasColor (GraphicsFormat format)
 Indicates whether given format has one more more color channels.
 
bool hasDepth (GraphicsFormat format)
 Indicates whether given format has depth channel.
 
bool hasSkipSystemInitialization (const SystemProperties &systemProperties)
 Checks whether one of the parameters is "-nosysinit".
 
bool hasStencil (GraphicsFormat format)
 Indicates whether given format has stencil channel.
 
bool hasToken (const SystemProperties &systemProperties, string_view token)
 Checks if system properties contain specified token.
 
Vector3 hslTosRGBColor (const Vector3 &vec)
 Converts a Vector3 from HSL color space to sRGB color space.
 
Vector4 hslTosRGBColor (const Vector4 &vec)
 Converts a Vector4 from HSLA color space to RGBA color space.
 
tuple< float, float, floathslTosRGBColor (float h, float s, float l)
 Converts a color from the HSL color space to the sRGB color space.
 
BitmapImageUniquePtr imageLoadJPEG (File &file, const LibJPEGParameters &libjpegParameters, string_view name="")
 Loads a JPEG image from an input stream.
 
BitmapImageUniquePtr imageLoadJPEG (File &file, string_view name="")
 Loads a JPEG image from an input stream.
 
BitmapImageUniquePtr imageLoadPNG (File &file, const LibPNGParameters &libpngParameters, string_view name="")
 Loads a PNG image from an input stream.
 
BitmapImageUniquePtr imageLoadPNG (File &file, string_view name="")
 Loads a PNG image from an input stream.
 
void imageSaveJPEG (const BitmapImage &image, File &file, float quality=1.0f)
 Saves an image as a JPEG to an output stream.
 
void imageSavePNG (const BitmapImage &image, File &file)
 Saves an image as a PNG to an output stream.
 
void imageSavePNGPaletted (const BitmapImage &image, File &file)
 Saves an image as a paletted PNG to an output stream.
 
template<typename T >
Rectangle< Tintersection (const Rectangle< T > &rectangle1, const Rectangle< T > &rectangle2)
 Calculates intersection of the two rectangles.
 
optional< Matrix3x3inverse (const Matrix3x3 &matrix)
 Applies an inversion to a matrix.
 
optional< Matrix4x4inverse (const Matrix4x4 &matrix)
 Applies an inversion to a matrix.
 
Quaternion inverse (const Quaternion &q)
 Returns an inverse quaternion for a quaternion.
 
optional< Matrix3x3inverseAffine (const Matrix3x3 &matrix)
 Applies an inversion to an affine matrix.
 
optional< Matrix4x4inverseAffine (const Matrix4x4 &matrix)
 Applies an inversion to an affine matrix.
 
optional< Matrix4x4inverseOrthogonal (const Matrix4x4 &matrix)
 Applies an inversion to an orthogonal affine matrix.
 
bool isAncestorOf (const Node &node, const Node &ancestor)
 Indicates whether one node is the ancestor of another node at any level in the node tree.
 
bool isCloseToZero (float value)
 Checks if floating point value is too close to zero.
 
bool isCompatibleWithUnitQuadGeometry (const QuadDescription &quadDescription, Vector2 tiling)
 Determines whether the given quad description and tiling are compatible with unit quad geometry.
 
bool isCompressed (GraphicsFormat format)
 Indicates whether format is compressed format or not.
 
bool isfinite (Vector2 vec)
 Overloading of kanzi::isfinite for kanzi::Vector2.
 
bool isFixedOperationOpCode (KzuExpressionValidatorOperation opCode)
 Tells if given operation code corresponds with a fixed operation.
 
KZ_NO_DISCARD bool isGLES1FlagSet (int glesFlags) noexcept
 Tests whether OpenGL ES1 is supported.
 
KZ_NO_DISCARD bool isGLES2FlagSet (int glesFlags) noexcept
 Tests whether OpenGL ES2 is supported.
 
KZ_NO_DISCARD bool isGLES3FlagSet (int glesFlags) noexcept
 Tests whether OpenGL ES3 is supported.
 
bool isImplicitMultisampleSupport (Multisample multisampleSupport)
 Tell if multisample support is of implicit type.
 
template<class T >
bool isInClosedInterval (T value, T min, T max)
 Check whether value is in [min, max] (an interval inclusive of the limit points).
 
bool isKeyModifier (LogicalKey key)
 Checks whether the key of the event is a modifier key.
 
bool isKzbMagic (ConstByteSpan data)
 Returns whether the beginning of a byte span matches a kzb magic byte sequence.
 
bool isKzbMagic (File &file)
 Returns whether the beginning of a file matches a kzb magic byte sequence.
 
bool isNativePixmapSurfaceConfigSupported (const EGLDisplay &eglDisplay, EGLNativePixmapType eglNativePixmap, const EGLConfig &eglConfig) noexcept
 Tests if a given EGL config is a valid pixmap surface configuration.
 
bool isNativeWindowSurfaceConfigSupported (const EGLDisplay &eglDisplay, EGLNativeWindowType eglNativeWindow, const EGLConfig &eglConfig) noexcept
 Tests if a given EGL config is a valid window surface configuration.
 
KZ_NO_DISCARD bool isNoConfig (const EGLConfig &eglConfig) noexcept
 Tests whether the given EGL configuration is no configuration.
 
KZ_NO_DISCARD bool isNoConfigHandle (const ::EGLConfig eglConfig) noexcept
 Tests whether the given EGL configuration handle is no configuration.
 
KZ_NO_DISCARD bool isNoContext (const EGLContext &eglContext) noexcept
 Tests if a given EGL context is no context.
 
KZ_NO_DISCARD bool isNoContextHandle (const ::EGLContext eglContextHandle) noexcept
 Tests if a given EGL context handle is no context.
 
bool isNodeInFocusableOverlay (const Node &node)
 Returns whether the given node is in one of the overlay scopes that are on top of the foremost modal scope, or in that modal scope itself.
 
KZ_NO_DISCARD bool isNoDisplay (const EGLDisplay &eglDisplay) noexcept
 Tests if a given EGL display is no display.
 
KZ_NO_DISCARD bool isNoDisplayHandle (const ::EGLDisplay eglDisplay) noexcept
 Tests if a given EGL display handle is no display.
 
bool isNoSurface (const EGLPixmapSurface &eglSurface) noexcept
 Tests if a given EGL surface is a no surface.
 
bool isNoSurface (const EGLWindowSurface &eglSurface) noexcept
 Tests if a given EGL surface is a no surface.
 
bool isNoSurfaceHandle (const ::EGLSurface eglSurfaceHandle) noexcept
 Tests if a given EGL surface handle is a no surface.
 
constexpr bool isOpaquableBlendMode (int blendMode)
 Indicates whether a blend mode can be rendered as opaque as substitute for clearing.
 
bool isOverlayFocusable (const OverlayScope &overlay)
 Returns whether the given overlay is focusable.
 
bool isOverlayScope (const FocusScope *scope)
 Returns whether the focus scope passed as argument is an overlay focus scope.
 
bool isPacked (GraphicsDataType dataType)
 Indicates whether given data type is packed or not.
 
bool isParentOf (const Node &child, const Node &parent)
 Indicates whether one node is the parent of another node.
 
bool isRTL (string_view text)
 Returns true if the text is right-to-left aligned, otherwise false.
 
bool isScalingOnly (const Matrix3x3 &matrix)
 Determines whether a matrix is scaling-only.
 
bool isTranslationOnly (const Matrix3x3 &matrix)
 Determines whether a matrix is translation-only.
 
bool isTranslationOnly (const Matrix4x4 &matrix)
 Returns whether a matrix is translation-only.
 
bool isValid (GraphicsFormat format)
 Indicates whether format is valid.
 
void javaErrorCallback (void *ctx, kanzi::interop::ErrorCode code, const char *message)
 Callback function that is used to pass exceptions to Java.
 
 KZ_ENABLE_BITMASK_OPERATORS (EGLContextClientVersion)
 
 KZ_ENABLE_BITMASK_OPERATORS (EGLSurfaceType)
 
 KZ_ENABLE_BITMASK_OPERATORS (FocusScope::ScopeFlag)
 
 KZ_ENABLE_BITMASK_OPERATORS (KeyModifier)
 
 KZ_ENABLE_BITMASK_OPERATORS (PointerButton)
 
 KZ_ENABLE_BITMASK_OPERATORS (QnxChannelIDFlags)
 
kzString kzErrorCodeToString (kzsError code)
 
string kzFormatVariadicLogMessage (kzString format,...)
 
string kzFormatVariadicLogMessageList (kzString format, va_list arguments)
 
KZ_ATTRIBUTE_NO_RETURN void kzThrowJNIError ()
 
KZ_ATTRIBUTE_NO_RETURN void kzThrowLegacyError (kzsError value)
 
KZ_ATTRIBUTE_NO_RETURN void kzThrowLegacyErrorFormat (kzsError value, kzString format,...)
 
KZ_ATTRIBUTE_NO_RETURN void kzThrowLegacyErrorMessage (kzsError value, const string &message)
 
KZ_ATTRIBUTE_NO_RETURN void kzThrowLegacyErrorMessage (kzsError value, kzString message)
 
ColorRGBA linearTosRGB (const ColorRGBA &cs)
 Converts whole ColorRGBA color from linear to sRGB.
 
Vector3 linearTosRGB (const Vector3 &vec)
 Converts to whole Vector3 from linear to sRGB.
 
Vector4 linearTosRGB (const Vector4 &vec)
 Conversion to whole Vector4 from linear to sRGB.
 
float linearTosRGB (float cl)
 Conversion from linear to sRGB for default gamma 2.2.
 
void listAllEGLConfigs (const EGLDisplay &eglDisplay) noexcept
 Prints metadata for all EGL configurations supported by an EGL display.
 
void listAllEGLConfigsFromDefaultDisplay () noexcept
 Lists available EGL configurations for the default EGL display.
 
void listEGLConfig (const EGLDisplay &eglDisplay, const EGLConfig &eglConfig) noexcept
 Prints metadata for the given EGL configuration.
 
void load (ApplicationProperties &applicationProperties, const SystemProperties &systemProperties)
 Loads application properties from system properties.
 
void load (ApplicationProperties &applicationProperties, string_view configurationFilePath)
 Loads application properties from configuration INI file.
 
BindingLoadInfo loadBinding (KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads a binding from a kzb file.
 
void loadBindings (KzbFile &kzbFile, KzbMemoryParser &parser, vector< BindingLoadInfo > &bindings)
 Loads bindings from a kzb file.
 
BitmapImageUniquePtr loadImage (Domain *domain, string_view imageUrl, bool isInCubemap)
 Loads an image from KZB file.
 
Mesh::CreateInfo loadMeshCreateInfo (Domain *domain, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Loads mesh create info from KZB.
 
void loadPrefabAsync (const Node &node, ResourceID prefabResourceId, ResourceManager::AsyncAcquireFinishedCallback callback)
 Acquires prefab and required nested resources recursively.
 
void loadSettings (ApplicationProperties &applicationProperties, const string_view configurationFilePath, const SystemProperties &systemProperties)
 Loads all properties, prioritizing command line parameters over configuration file parameters.
 
ShaderProgram::CreateInfo loadShaderProgramCreateInfo (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser, string_view name)
 Loads a shader program create info from a kzb file.
 
SplinePtr loadSplineFromKZB (KzbMemoryParser &parser)
 Load a spline spline from memory parser.
 
Texture::CreateInfo loadTextureCreateInfo (Domain *domain, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Load texture create info from KZB file.
 
template<>
string logArgumentToString (const bool &value)
 Used by logging system to convert bool to string.
 
template<>
string logArgumentToString (const exception &exception)
 Used by logging system to convert standard exception type objects to string.
 
template<>
string logArgumentToString (const FixedString &fixedString)
 Used by logging system to convert fixed strings to string.
 
template<>
string logArgumentToString (const ImmutableString &immutableString)
 Used by logging system to convert immutable strings to string.
 
template<>
string logArgumentToString (const JNIError &jniError)
 Used by logging system to convert legacy exception type objects to string.
 
template<>
string logArgumentToString (const LegacyError &legacyError)
 Used by logging system to convert legacy exception type objects to string.
 
template<>
string logArgumentToString (const SharedImmutableString &sharedImmutableString)
 Used by logging system to convert shared immutable strings to string.
 
template<>
string logArgumentToString (const string_view &stringView)
 Used by logging system to convert string_view to string.
 
template<typename T >
string logArgumentToString (const T &value)
 The logging subsystem uses this function to convert a value to string.
 
template<typename TBase , typename T >
shared_ptr< Tmake_polymorphic_shared_ptr (T *p)
 
bool makeCurrentEGLContext (const EGLDisplay &eglDisplay, const EGLPBufferSurface &eglSurface, const EGLContext &eglContext) noexcept
 Binds a pbuffer surface to a context and the current thread.
 
bool makeCurrentEGLContext (const EGLDisplay &eglDisplay, const EGLPixmapSurface &eglSurface, const EGLContext &eglContext) noexcept
 Binds a pixmap surface to a context and the current thread.
 
bool makeCurrentEGLContext (const EGLDisplay &eglDisplay, const EGLWindowSurface &eglSurface, const EGLContext &eglContext) noexcept
 Binds a window surface to a context and the current thread.
 
EventSourceSharedPtr makeDefaultEventSource (const SystemConfiguration &configuration)
 Creates a platform-specific event source.
 
KZ_NO_DISCARD GraphicsOutputSharedPtr makeDefaultGraphicsOutput (const SystemConfiguration &configuration)
 Creates a platform-specific graphics output.
 
EventSourceSharedPtr makeLegacyEventSource (const EventSourceProperties &properties, GraphicsOutput *graphicsOutput)
 Creates a legacy event source.
 
KZ_NO_DISCARD GraphicsOutputSharedPtr makeLegacyGraphicsOutput (const struct KzsSurfaceProperties *surfaceProperties, const NativeWindowProperties *windowProperties, const NativeDesktopProperties *desktopProperties)
 Creates a legacy graphics output.
 
KeyMatchResult matchKeyGesture (const KeyGestureInfo &gesture, const KeyEvent &event)
 Detects key gestures from the event that you pass as an argument.
 
KeyMatchResult matchModifiers (KeyModifier required, const KeyEvent &event)
 Returns whether the modifiers of the key event match the required modifiers.
 
Quaternion matrix4x4ToQuaternion (const Matrix4x4 &matrix)
 Creates a quaternion from Matrix4x4.
 
float matrixMultiplyAffineGetTranslationZ (const kanzi::Matrix4x4 &lhs, const kanzi::Matrix4x4 &rhs)
 Gets translation Z component from product of two matrices, where both are affine transformations.
 
Vector2 matrixMultiplyVectorBy2x2 (const Matrix3x3 &matrix, const Vector2 vector)
 Multiply a 2D vector with the top 2x2 part of a given matrix.
 
Vector3 matrixMultiplyVectorBy3x3 (const Matrix4x4 &matrix, const Vector3 vector)
 Multiplies a 3D vector with the top 3x3 part of a given matrix.
 
template<class DerivedClassType , class CurvePointType >
void messagingAndChangeSignaling (DerivedClassType &m_derivedClass, optional< float > &m_lastHitPointValue, CurvePointType &m_lastHitPoint, CurvePointType &closestCurvePoint, float distanceAlongCurve, float shortestDistance, InputManipulator::InputMessageArguments &message)
 
Matrix4x4 multiplyAffine (const Matrix4x4 &left, const Matrix4x4 &right)
 Multiplies two affine matrices and returns the product.
 
void nodeLookAt (Node3D &node, Vector3 position, Vector3 lookAtPoint, Vector3 upVector)
 Sets node transformation so that the node is in a given position turned toward a given point.
 
Matrix4x4 normalizeBase (const Matrix4x4 &matrix)
 Normalizes base vectors of a matrix.
 
optional< Matrix3x3normalized (const Matrix3x3 &matrix)
 Normalizes the input matrix.
 
bool operator!= (ColorRGBA v1, ColorRGBA v2)
 Compares two colors for inequality.
 
bool operator!= (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
 Inequality operator overload for focus chain index.
 
bool operator!= (const KeyEvent &lhs, const KeyEvent &rhs)
 Inequality operator for KeyEvents.
 
bool operator!= (const Quaternion &q1, const Quaternion &q2)
 Inequality comparison operator, compares if two quaternions are exactly not equal.
 
template<typename T >
bool operator!= (const shared_ptr< T > &v, nullptr_t)
 
template<typename T >
bool operator!= (const unique_ptr< T > &v, nullptr_t)
 
bool operator!= (FixedString left, string_view right)
 
bool operator!= (Matrix3x3 left, Matrix3x3 right)
 Inequality operator.
 
template<typename T >
bool operator!= (nullptr_t, const shared_ptr< T > &v)
 
template<typename T >
bool operator!= (nullptr_t, const unique_ptr< T > &v)
 
bool operator!= (string_view left, FixedString right)
 
bool operator!= (Vector2 v1, Vector2 v2)
 Compares two vectors for inequality.
 
bool operator!= (Vector3 v1, Vector3 v2)
 Compares two vectors for inequality.
 
bool operator!= (Vector4 v1, Vector4 v2)
 Compares two vectors for inequality.
 
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type operator& (Enum lhs, Enum rhs)
 Bitwise AND operator between two enum class values.
 
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type operator&= (Enum &lhs, Enum rhs)
 Bitwise AND assignment operator between two enum class values.
 
ColorRGBA operator* (ColorRGBA v, float scalar)
 Multiplies all color elements with a scalar and returns the resulting color.
 
Matrix4x4 operator* (const Matrix4x4 &left, const Matrix4x4 &right)
 Multiplies two matrices and returns the product.
 
Quaternion operator* (const Quaternion &q1, const Quaternion &q2)
 Multiplies two quaternions.
 
ColorRGBA operator* (float scalar, ColorRGBA v)
 Multiplies all color elements with a scalar and returns the resulting color.
 
Vector2 operator* (float scalar, Vector2 v)
 Multiplies all vector elements with a scalar and returns the resulting vector.
 
Vector3 operator* (float scalar, Vector3 v)
 Multiplies all vector elements with a scalar and returns the resulting vector.
 
Vector4 operator* (float scalar, Vector4 v)
 Multiplies all vector elements with a scalar and returns the resulting vector.
 
Vector2 operator* (Matrix3x3 m, Vector2 v)
 Multiplies matrix with vector and returns the product.
 
Vector3 operator* (Matrix3x3 m, Vector3 v)
 Multiplies matrix with vector and returns the product.
 
Matrix3x3 operator* (Matrix3x3 m1, Matrix3x3 m2)
 Multiplies two matrices and returns the product.
 
Vector2 operator* (Vector2 v, float scalar)
 Multiplies all vector elements with a scalar and returns the resulting vector.
 
Vector3 operator* (Vector3 v, float scalar)
 Multiplies all vector elements with a scalar and returns the resulting vector.
 
Vector4 operator* (Vector4 v, float scalar)
 Multiplies all vector elements with a scalar and returns the resulting vector.
 
ColorRGBA operator+ (ColorRGBA v)
 Unary plus, doesn't do anything and returns the resulting color.
 
ColorRGBA operator+ (ColorRGBA v1, ColorRGBA v2)
 Adds two colors and returns the sum.
 
ColorRGBA operator+ (ColorRGBA v1, float v2)
 Adds a color and a scalar and returns the sum.
 
ColorRGBA operator+ (float v1, ColorRGBA v2)
 Adds a color and a scalar and returns the sum.
 
Vector2 operator+ (float v1, Vector2 v2)
 Adds a scalar and a vector and returns the sum.
 
Vector3 operator+ (float v1, Vector3 v2)
 Adds a scalar and a vector and returns the sum.
 
Vector4 operator+ (float v1, Vector4 v2)
 Adds a scalar and a vector and returns the sum.
 
Vector2 operator+ (Vector2 v)
 Unary plus, doesn't do anything and returns the resulting vector.
 
Vector2 operator+ (Vector2 v1, float v2)
 Adds a vector and a scalar and returns the sum.
 
Vector2 operator+ (Vector2 v1, Vector2 v2)
 Adds two vectors and returns the sum.
 
Vector3 operator+ (Vector3 v)
 Unary plus, doesn't do anything and returns the resulting vector.
 
Vector3 operator+ (Vector3 v1, float v2)
 Adds a vector and a scalar and returns the sum.
 
Vector3 operator+ (Vector3 v1, Vector3 v2)
 Adds two vectors and returns the sum.
 
Vector4 operator+ (Vector4 v)
 Unary plus, doesn't do anything and returns the resulting vector.
 
Vector4 operator+ (Vector4 v1, float v2)
 Adds a vector and a scalar and returns the sum.
 
Vector4 operator+ (Vector4 v1, Vector4 v2)
 Adds two vectors and returns the sum.
 
ColorRGBA operator- (ColorRGBA v)
 Negates all color elements and returns the resulting color.
 
ColorRGBA operator- (ColorRGBA v1, ColorRGBA v2)
 Subtracts two colors and returns the difference.
 
Vector2 operator- (Vector2 v)
 Negates all vector elements and returns the resulting vector.
 
Vector2 operator- (Vector2 v1, Vector2 v2)
 Subtracts two vectors and returns the difference.
 
Vector3 operator- (Vector3 v)
 Negates all vector elements and returns the resulting vector.
 
Vector3 operator- (Vector3 v1, Vector3 v2)
 Subtracts two vectors and returns the difference.
 
Vector4 operator- (Vector4 v)
 Negates all vector elements and returns the resulting vector.
 
Vector4 operator- (Vector4 v1, Vector4 v2)
 Subtracts two vectors and returns the difference.
 
ColorRGBA operator/ (ColorRGBA v, float scalar)
 Divides all color elements with a scalar and returns the resulting color.
 
Vector2 operator/ (Vector2 v, float scalar)
 Divides all vector elements with a scalar and returns the resulting vector.
 
Vector3 operator/ (Vector3 v, float scalar)
 Divides all vector elements with a scalar and returns the resulting vector.
 
Vector4 operator/ (Vector4 v, float scalar)
 Divides all vector elements with a scalar and returns the resulting vector.
 
bool operator< (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
 Less operator overload for focus chain index.
 
bool operator<= (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
 Less or equal operator overload for focus chain index.
 
bool operator== (ColorRGBA v1, ColorRGBA v2)
 Compares two colors for equality.
 
bool operator== (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
 Equality operator overload for focus chain index.
 
bool operator== (const KeyEvent &lhs, const KeyEvent &rhs)
 Equality operator for KeyEvents.
 
bool operator== (const Quaternion &q1, const Quaternion &q2)
 Equality comparison operator, compares if two quaternions are exactly equal.
 
template<typename T >
bool operator== (const shared_ptr< T > &v, nullptr_t)
 
template<typename T >
bool operator== (const unique_ptr< T > &v, nullptr_t)
 
bool operator== (FixedString left, string_view right)
 
bool operator== (Matrix3x3 left, Matrix3x3 right)
 Equality operator.
 
template<typename T >
bool operator== (nullptr_t, const shared_ptr< T > &v)
 
template<typename T >
bool operator== (nullptr_t, const unique_ptr< T > &v)
 
bool operator== (string_view left, FixedString right)
 
bool operator== (Vector2 v1, Vector2 v2)
 Compares two vectors for equality.
 
bool operator== (Vector3 v1, Vector3 v2)
 Compares two vectors for equality.
 
bool operator== (Vector4 v1, Vector4 v2)
 Compares two vectors for equality.
 
bool operator> (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
 Greater operator overload for focus chain index.
 
bool operator>= (const FocusChainIndex &lhs, const FocusChainIndex &rhs)
 Greater or equal operator overload for focus chain index.
 
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type operator^ (Enum lhs, Enum rhs)
 Bitwise XOR operator between two enum class values.
 
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type operator^= (Enum &lhs, Enum rhs)
 Bitwise XOR assignment operator between two enum class values.
 
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type operator| (Enum lhs, Enum rhs)
 Bitwise OR operator between two enum class values.
 
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum & >::type operator|= (Enum &lhs, Enum rhs)
 Bitwise OR assignment operator between two enum class values.
 
template<typename Enum >
enable_if< enable_bitmask_operators< Enum >::enable, Enum >::type operator~ (Enum lhs)
 Bitwise NOT operator over an enum class value.
 
Matrix4x4 orthonormalizeBase (const Matrix4x4 &matrix)
 Orthonormalizes base vectors of the given matrix.
 
template<typename T >
bool overlaps (const Rectangle< T > &rectangle1, const Rectangle< T > &rectangle2)
 Checks if the two given rectangles overlap, at least partially.
 
template<typename T >
void overrideMetaclass (ObjectFactory &objectFactory)
 
int parseQnxContextTypeValue (const SystemConfiguration &configuration, const string &key, int defaultValue)
 Parses QNX context type flags from the system configuration.
 
template<>
EGLContextClientSelection parseValue (const SystemConfiguration &configuration, const string &key, EGLContextClientSelection defaultValue)
 
template<>
EGLSurfaceType parseValue (const SystemConfiguration &configuration, const string &key, EGLSurfaceType defaultValue)
 
template<>
int parseValue (const SystemConfiguration &configuration, const string &key, int defaultValue)
 
template<>
optional< EGLIMGContextPriorityparseValue (const SystemConfiguration &configuration, const string &key, optional< EGLIMGContextPriority > defaultValue)
 
template<>
optional< intparseValue (const SystemConfiguration &configuration, const string &key, optional< int > defaultValue)
 
template<>
optional< unsigned intparseValue (const SystemConfiguration &configuration, const string &key, optional< unsigned int > defaultValue)
 
template<>
string parseValue (const SystemConfiguration &configuration, const string &key, string defaultValue)
 
template<>
SurfaceColorSpace parseValue (const SystemConfiguration &configuration, const string &key, SurfaceColorSpace defaultValue)
 
template<typename T >
T parseValue (const SystemConfiguration &configuration, const string &key, T defaultValue)
 
template<>
unsigned int parseValue (const SystemConfiguration &configuration, const string &key, unsigned int defaultValue)
 
template<>
WindowStyle parseValue (const SystemConfiguration &configuration, const string &key, WindowStyle defaultValue)
 
optional< PlanePlaneIntersectionplaneIntersectPlane (const Plane &plane1, const Plane &plane2, float parallelTolerance)
 Checks whether two planes intersect and returns a point and direction vector for the line of intersection.
 
optional< PlaneRayIntersectionplaneIntersectRay (const Plane &plane, const Ray &ray, const float parallelTolerance)
 Tests whether a plane intersects with the given ray, and returns the point of intersection and the distance of the intersection from the origin of a plane.
 
optional< TouchEventpointerToTouchEvent (const PointerEvent &pointer)
 Converts a pointer event to an equivalent touch event.
 
float positiveModulo (float dividend, float divisor)
 Same as positiveModulo(), but for floating point numbers.
 
unsigned int positiveModulo (int dividend, unsigned int divisor)
 Returns the positive modulo(dividend % divisor) for signed numbers in a way that negative numbers are treated as an extension instead of mirroring compared to positive numbers.
 
EventQueue::Container::iterator prepend (EventQueue &queue, EventQueue::Container::iterator position, EventQueue::Container &container)
 Moves a container content into a queue before the given position.
 
EventQueue::Container::iterator prepend (EventQueue &queue, EventQueue::Container::iterator position, UniqueEventPtr &&event)
 Inserts an event into a queue before the given position.
 
EventQueue::Container::iterator prependAndAdvance (EventQueue &queue, EventQueue::Container::iterator position, EventQueue::Container &container)
 Moves a container content into a queue before the given position.
 
EventQueue::Container::iterator prependAndAdvance (EventQueue &queue, EventQueue::Container::iterator position, UniqueEventPtr &&event)
 Inserts an event content into a queue before the given position.
 
template<class T >
T prev (T t)
 
template<class T , class D >
T prev (T t, D d)
 
void previewPatch (Domain *domain, unique_ptr< KzbFile > patch)
 
PropertyField propertyFieldFromBinaryTargetAttribute (KzuPropertyBinaryTargetAttribute attribute)
 Converts a property target attribute from binary into a property field.
 
float pseudoCrossProduct (const Vector2 &left, const Vector2 &right)
 Calculates pseudo-cross product of two 2D vectors.
 
Quaternion quaternionSlerp (const Quaternion &q1, const Quaternion &q2, float interpolationTime)
 Applies spherical linear interpolation (slerp) to two quaternions using the shortest path.
 
Quaternion quaternionSlerpLongerPath (const Quaternion &q1, const Quaternion &q2, float interpolationTime)
 Applies spherical linear interpolation (slerp) to two quaternion using the longer path.
 
Matrix4x4 quaternionToMatrix4x4 (const Quaternion &quaternion)
 Converts a quaternion rotation to a 4x4 rotation matrix.
 
constexpr float radiansToDegrees (float angleInRadians)
 Converts radians to degrees.
 
RayBoxIntersection rayIntersectBox (const Ray &ray, const Box &box, const Matrix4x4 &boxOrientation)
 Tests whether a ray intersects with a bounding box and returns the distance.
 
RayBoxIntersection rayIntersectBox (const Ray &ray, const Vector3 minCorner, const Vector3 maxCorner, const Matrix4x4 &boxOrientation)
 Tests whether a ray intersects with a bounding box and returns the distance.
 
RayBoxIntersection rayIntersectBoxBackface (const Ray &ray, const Box &box, const Matrix4x4 &boxOrientation)
 Tests whether a ray intersects with the back faces of a bounding box and returns the distance.
 
RayBoxIntersection rayIntersectBoxBackface (const Ray &ray, const Vector3 minCorner, const Vector3 maxCorner, const Matrix4x4 &boxOrientation)
 Tests whether a ray intersects with the back faces of a bounding box and returns the distance.
 
optional< floatrayIntersectCylinder (const Ray &ray, const float cylinderRadius, const float cylinderHeight, const Vector3 cylinderAxis, const Matrix4x4 &cylinderTransform)
 Tests whether a ray intersects with a cylinder aligned on the given unit-axis (within range [-height/2, height/2]).
 
optional< floatrayIntersectSphere (const Ray &ray, const Vector3 spherePosition, const float sphereRadius)
 Tests whether a ray intersects with a sphere and returns the distance.
 
KZ_DEPRECATED RayPickResult rayPickHitTest (const Vector2 &limits, OverlayScope &scope, Scene *scene, Camera *camera, int x, int y)
 Input hit testing.
 
RayPickResult rayPickHitTest (const Vector2 &limits, Scene *scene, Camera *camera, int x, int y)
 Input hit testing.
 
template<class T >
T::reverse_iterator rbegin (T &t)
 
string readAsText (File &file)
 Loads contents of a file into a string.
 
vector< string > readAsTextLines (File &file)
 Loads contents of a file into a vector of strings for each line.
 
float readVertexAttributeComponent (const Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex, unsigned int component)
 Reads one attribute component of given vertex from mesh create info.
 
float readVertexAttributeFloat (const Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex)
 Reads float attribute of given vertex from mesh.
 
Vector2 readVertexAttributeVector2 (const Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex)
 Reads Vector2 attribute of given vertex from mesh.
 
Vector3 readVertexAttributeVector3 (const Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex)
 Reads Vector3 attribute of given vertex from mesh.
 
Vector4 readVertexAttributeVector4 (const Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex)
 Reads Vector4 attribute of given vertex from mesh.
 
void registerDefaultResources (Screen &screen)
 Registers default resources in the resource manager and Screen node's dictionary.
 
void registerDefaultTypes (ObjectFactory &objectFactory)
 Registers default Kanzi object types in object factory.
 
template<typename T >
void registerMetaclass (ObjectFactory &objectFactory)
 
void registerNodeComponentLoader (ObjectLoader &objectLoader, const Metaclass *metaclass)
 Registers node component template loader for specified node component type.
 
void registerNodeComponentLoaders (ObjectLoader &objectLoader)
 Registers node component template loaders for build-in node component types.
 
void registerRuntimeAssets (Domain *domain)
 Registers build-in runtime assets in resource manager of domain so they can be acquired at runtime.
 
void registerTimelineLoaders (ObjectLoader &objectLoader)
 Registers loaders for build-in timeline types.
 
void registerUIAssets (Domain *domain)
 Registers build-in UI assets in resource manager of domain so they can be acquired at runtime.
 
bool releaseCurrentEGLContext (const EGLDisplay &eglDisplay) noexcept
 Releases surfaces and context bound to the current thread.
 
template<class T >
T::reverse_iterator rend (T &t)
 
void resetStopWatch (StopWatch &stopWatch)
 Resets the stop watch.
 
PropertyDataType resolveDataType (AbstractPropertyType propertyType, PropertyField field)
 Resolve data type for a reading or writing.
 
template<typename T >
float retrieveFieldValue (const T &value, PropertyField field)
 Free function for retrieving a value of a field.
 
template<>
float retrieveFieldValue< ColorRGBA > (const ColorRGBA &value, PropertyField field)
 Specialization of retrieveFieldValue.
 
template<>
float retrieveFieldValue< Matrix3x3 > (const Matrix3x3 &value, PropertyField field)
 Specialization of retrieveFieldValue.
 
template<>
float retrieveFieldValue< Matrix4x4 > (const Matrix4x4 &value, PropertyField field)
 Specialization of retrieveFieldValue.
 
template<>
float retrieveFieldValue< SRTValue2D > (const SRTValue2D &value, PropertyField field)
 Specialization of retrieveFieldValue.
 
template<>
float retrieveFieldValue< SRTValue3D > (const SRTValue3D &value, PropertyField field)
 Specialization of retrieveFieldValue.
 
template<>
float retrieveFieldValue< Vector2 > (const Vector2 &value, PropertyField field)
 Specialization of retrieveFieldValue.
 
template<>
float retrieveFieldValue< Vector3 > (const Vector3 &value, PropertyField field)
 Specialization of retrieveFieldValue.
 
template<>
float retrieveFieldValue< Vector4 > (const Vector4 &value, PropertyField field)
 Specialization of retrieveFieldValue.
 
Vector3 rotateVector (const Quaternion &quaternion, Vector3 vector)
 Applies quaternion rotation to a vector.
 
float roundDown (double num)
 Helper function similar to floor, but takes a double and returns a float.
 
template<typename HostType , typename TemplateSharedPtrType >
BindingRuntimeHandle setBindingToBindingHost (HostType &bindingHost, TemplateSharedPtrType templateRoot, AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, optional< PropertyValuePrecedence > precedence, PropertyField field)
 Helper function to set bindings to binding hosts.
 
void setPlatformMmapMode (MmapMode mode)
 Set mmap() strategy.
 
void setScopeFocusedNode (Node &scope, Node &node)
 Sets the focus node for the given scope node.
 
bool shutdownEGL (EGLDisplay &eglDisplay) noexcept
 Terminates current EGL display connection.
 
template<class C >
constexpr auto size (const C &c) -> decltype(c.size())
 
template<class T , size_t N>
constexpr size_t size (const T(&)[N]) noexcept
 
vector< string > splitString (const string &source, const string &delimiter)
 Splits string to tokens.
 
vector< string_view > splitString (string_view source, string_view delimiter)
 Splits string view to tokens.
 
Vector3 sRGBToHSLColor (const Vector3 &vec)
 Converts a Vector3 from sRGB color space to HSL color space.
 
Vector4 sRGBToHSLColor (const Vector4 &vec)
 Converts a Vector4 from RGBA color space to HSLA color space.
 
tuple< float, float, floatsRGBToHSLColor (float r, float g, float b)
 Converts a color from the sRGB color space to the HSL color space.
 
ColorRGBA sRGBToLinear (const ColorRGBA &cs)
 Converts to whole ColorRGBA from sRGB to linear.
 
Vector3 sRGBToLinear (const Vector3 &vec)
 Converts to whole Vector3 from sRGB to linear.
 
Vector4 sRGBToLinear (const Vector4 &vec)
 Conversion to whole Vector4 from sRGB to linear.
 
float sRGBToLinear (float cs)
 Conversion from sRGB to linear for default gamma 2.2.
 
constexpr float step (float edge, float value)
 Calculate step for floating point values.
 
constexpr int step (int edge, int value)
 Calculate step for integers.
 
float strtof (const char *val, char **end_ptr)
 
KZ_NO_DISCARD bool supportsContextClientVersion (const EGLDisplay &eglDisplay, const ::EGLConfig eglConfig, EGLContextClientVersion version) noexcept
 Returns whether EGLConfig supports EGLContextClientVersion.
 
void swap (Mesh::CreateInfo &createInfo1, Mesh::CreateInfo &createInfo2)
 
void swap (Mesh::CreateInfo::Cluster &cluster1, Mesh::CreateInfo::Cluster &cluster2)
 
void swap (MeshVertexAttribute &attribute1, MeshVertexAttribute &attribute2)
 
void swap (Renderbuffer &buffer1, Renderbuffer &buffer2)
 
void swap (ShaderProgram &shader1, ShaderProgram &shader2)
 
void swap (ShaderProgram::CreateInfo &createInfo1, ShaderProgram::CreateInfo &createInfo2)
 
void swap (ShaderVertexAttribute &attribute1, ShaderVertexAttribute &attribute2)
 
void swap (Texture &texture1, Texture &texture2)
 
void swap (Texture::CreateInfo &info1, Texture::CreateInfo &info2)
 
void swap (VertexAttribute &attribute1, VertexAttribute &attribute2)
 
constexpr TextureSwizzleMask SwizzleMaskARGBToRGBA (TextureSwizzleMask::ColorComponent::Green, TextureSwizzleMask::ColorComponent::Blue, TextureSwizzleMask::ColorComponent::Alpha, TextureSwizzleMask::ColorComponent::Red)
 Masks the color channels from ARGB to RGBA.
 
constexpr TextureSwizzleMask SwizzleMaskLuminanceToRGBA (TextureSwizzleMask::ColorComponent::Alpha)
 Masks all color channels with alpha.
 
constexpr TextureSwizzleMask SwizzleMaskRGBToLuminanceAlpha (TextureSwizzleMask::ColorComponent::Red, TextureSwizzleMask::ColorComponent::Red, TextureSwizzleMask::ColorComponent::Red, TextureSwizzleMask::ColorComponent::Alpha)
 Masks all color channels with red.
 
string to_string (const ResourceID &id)
 Converts a ResourceID to a string.
 
string to_string (double value)
 
string to_string (FixedString fixedString)
 
string to_string (float value)
 
string to_string (int value)
 
string to_string (long double value)
 
string to_string (long long value)
 
string to_string (long value)
 
string to_string (RenderPass::AttachmentState attachmentState)
 Returns a string representation of an attachment state.
 
string to_string (unsigned int value)
 
string to_string (unsigned long long value)
 
string to_string (unsigned long value)
 
FixedString toFixedString (GraphicsDataType dataType)
 Returns human readable string for GraphicsDataType.
 
FixedString toFixedString (GraphicsFormat format)
 Returns human readable string for GraphicsFormat.
 
FixedString toFixedString (Sampler::Filter filter)
 
FixedString toFixedString (Sampler::MipmapMode mipmapMode)
 
FixedString toFixedString (VertexAttribute::Semantic semantic)
 Returns human readable string for semantic.
 
optional< ShaderProgram::FixedUniformtoFixedUniform (string_view uniformName)
 Gets FixedUniform from given string.
 
unsigned char toLower (unsigned char ch)
 Wrapper for tolower() that returns unsigned char.
 
optional< VertexAttribute::SemantictoVertexAttributeSemantic (unsigned int kzbVertexAttributeSemantic)
 Converts KZB vertex attribute semantic to runtime VertexAttribute::Semantic.
 
string_view trim (string_view input)
 boost::trim() implementation for string_view.
 
string_view truncateToUtf8Length (string_view text, size_t length)
 
void tryCollectResourceUrlsFromPrefabTemplateUrl (ResourceManager *resourceManager, string_view prefabTemplateUrl, const Node &node, ResourceManager::UrlContainer &urls)
 Collects URLs from all resource properties that are used by the nodes in a prefab template, like collectResourceUrlsFromPrefabTemplateUrl, but does not throw an exception if the prefab template is not found.
 
void tryCollectResourceUrlsFromPrefabTemplateUrl (ResourceManager *resourceManager, string_view prefabTemplateUrl, ResourceManager::UrlContainer &urls)
 Collects URLs from all resource properties that are used by the nodes in a prefab template, like collectResourceUrlsFromPrefabTemplateUrl, but does not throw an exception if the prefab template is not found.
 
KZ_NO_DISCARD optional< EGLinttryGetEGLAttributeValue (const EGLDisplay &eglDisplay, ::EGLConfig eglConfig, EGLint attributeName) noexcept
 Tries to get an EGL attribute value associated with the attribute name.
 
template<size_t I = 0, typename Function , typename... TupleArgs>
enable_if_t< I==sizeof...(TupleArgs), voidtupleForEach (const tuple< TupleArgs... > &, Function &&)
 Applies a function to each element of a tuple (const version).
 
template<size_t I = 0, typename Function , typename... TupleArgs>
enable_if_t<(I< sizeof...(TupleArgs)), voidtupleForEach (const tuple< TupleArgs... > &tuple, Function &&function)
 Applies a function to each element of a tuple (const version).
 
template<size_t I = 0, typename Function , typename... TupleArgs>
enable_if_t< I==sizeof...(TupleArgs), voidtupleForEach (tuple< TupleArgs... > &, Function &&)
 Applies a function to each element of a tuple.
 
template<size_t I = 0, typename Function , typename... TupleArgs>
enable_if_t<(I< sizeof...(TupleArgs)), voidtupleForEach (tuple< TupleArgs... > &tuple, Function &&function)
 Applies a function to each element of a tuple.
 
template<typename T >
PropertyDataType typeToPropertyDataType ()
 Reverse lookup for data type.
 
template<>
PropertyDataType typeToPropertyDataType< AbstractRangeSharedPtr > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< bool > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< ColorRGBA > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< float > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< int > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< Matrix3x3 > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< Matrix4x4 > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< ResourceSharedPtr > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< SRTValue2D > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< SRTValue3D > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< string > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< Vector2 > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< Vector3 > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< Vector4 > ()
 Specialization of typeToPropertyDataType().
 
template<>
PropertyDataType typeToPropertyDataType< void * > ()
 Specialization of typeToPropertyDataType().
 
template<typename T , typename A >
void unordered_erase (vector< T, A > &c, typename vector< T, A >::iterator it)
 Erases an entry from a vector without preserving the order of other entries.
 
void unregisterRenderEntry (DrawObjectsRenderPass &drawPass, Node3D &node)
 Remove references of node render entries from a draw objects render pass.
 
FocusChainNode unwrapFocusChainNode (FocusScope::FocusChain::FocusedTuple wrapped)
 Unwraps the focus chain node representation of the focused node of a focus scope from a wrapped node.
 
ObjectSourceRuntimeSharedPtr updateObjectSourceRuntime (ObjectSourceRuntimeSharedPtr runtime, NodeListSharedPtr nodeList, ObjectSourceSharedPtr filter)
 Updates an existing filter runtime or returns a new one.
 
template<typename T >
void updateRenderValue (Renderer &renderer, GlRenderValue< T > &value)
 Update render value container to GPU.
 
template<typename T >
bool updateRenderValue (Renderer &renderer, GlRenderValue< T > &value, unsigned int textureUnit)
 Update render value container to the GPU.
 
template<>
bool updateRenderValue (Renderer &renderer, GlRenderValue< TextureSharedPtr > &value, unsigned int textureUnit)
 updateRenderValueContainer() specialization.
 
template<>
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< bool > &value)
 updateRenderValueOverride() specialization.
 
template<>
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< ColorRGBA > &value)
 updateRenderValueOverride() specialization.
 
template<>
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< float > &value)
 updateRenderValueOverride() specialization.
 
template<>
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< int > &value)
 updateRenderValueOverride() specialization.
 
template<>
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< Matrix3x3 > &value)
 updateRenderValueOverride() specialization.
 
template<>
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< Matrix4x4 > &value)
 updateRenderValueOverride() specialization.
 
template<typename T >
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< T > &value)
 Type-specific render value update to GPU.
 
template<>
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< Vector2 > &value)
 updateRenderValueOverride() specialization.
 
template<>
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< Vector3 > &value)
 updateRenderValueOverride() specialization.
 
template<>
void updateRenderValueOverride (Renderer &renderer, const GlRenderValue< Vector4 > &value)
 updateRenderValueOverride() specialization.
 
void updateVertexAttributeOffsetsAndVertexSize (Mesh::CreateInfo &createInfo)
 Sets offsets for vertex attributes in mesh create info.
 
void updateVertexAttributeStrides (Mesh::CreateInfo &createInfo)
 Calculates vertex format size and updates stride to all vertex attributes in mesh create info.
 
unsigned int uround (float value)
 Round float to unsigned integer.
 
template<typename T >
Variant variantCast (const Variant &value)
 Casts variant to another data type.
 
Variant variantCast (const Variant &value, PropertyDataType targetDataType)
 Casts variant to another data type.
 
template<>
Variant variantCast< AbstractRangeSharedPtr > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< bool > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< ColorRGBA > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< float > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< int > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< Matrix3x3 > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< Matrix4x4 > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< ResourceSharedPtr > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< SRTValue2D > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< SRTValue3D > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< string > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< Vector2 > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< Vector3 > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< Vector4 > (const Variant &value)
 Specialization of typed variantCast.
 
template<>
Variant variantCast< void * > (const Variant &value)
 Specialization of typed variantCast.
 
bool variantSetToDataObject (const Variant &value, DataObject &dataObject)
 Sets variant value to a data object.
 
void writeVertexAttribute (Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex, float v)
 Writes one float attribute value to vertex data.
 
void writeVertexAttribute (Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex, unsigned int component, float v)
 Writes one float attribute component to vertex data.
 
void writeVertexAttribute (Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex, Vector2 v)
 Writes one Vector2 attribute value to vertex data.
 
void writeVertexAttribute (Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex, Vector3 v)
 Writes one Vector3 attribute value to vertex data.
 
void writeVertexAttribute (Mesh::CreateInfo &createInfo, unsigned int vertexIndex, unsigned int attributeIndex, Vector4 v)
 Writes one Vector3 attribute value to vertex data.
 
void swap (Mesh::Skeleton &skeleton1, Mesh::Skeleton &skeleton2)
 
void swap (Mesh::Cluster &cluster1, Mesh::Cluster &cluster2)
 
void swap (Mesh &mesh1, Mesh &mesh2)
 

Variables

constexpr auto c_keyRepeatDelay
 Specifies the time in milliseconds Kanzi waits before it detects a key-repeat gesture.
 
constexpr auto c_keyRepeatInterval
 Specifies the time in milliseconds between the key-press repetitions.
 
const string ConfigurationKeyDefaultDisplayIndex
 Key to access the default display index of the system configuration.
 
const string ConfigurationKeyDefaultSurfaceBitsAlpha
 Key to access the default surface bits alpha of the system configuration.
 
const string ConfigurationKeyDefaultSurfaceBitsBlue
 Key to access the default surface bits blue of the system configuration.
 
const string ConfigurationKeyDefaultSurfaceBitsDepth
 Key to access the default surface bits depth of the system configuration.
 
const string ConfigurationKeyDefaultSurfaceBitsGreen
 Key to access the default surface bits green of the system configuration.
 
const string ConfigurationKeyDefaultSurfaceBitsRed
 Key to access the default surface bits red of the system configuration.
 
const string ConfigurationKeyDefaultSurfaceBitsStencil
 Key to access the default surface bits stencil of the system configuration.
 
const string ConfigurationKeyDefaultSurfaceSamplesAntialiasing
 Key to access the default surface anti-aliasing sample count of the system configuration.
 
const string ConfigurationKeyDefaultSurfaceType
 Key to access the default surface type of the system configuration.
 
const string ConfigurationKeyDefaultWindowClassName
 Key to access the default window class name of the system configuration.
 
const string ConfigurationKeyDefaultWindowHeight
 Key to access the default window height parameter of the system configuration.
 
const string ConfigurationKeyDefaultWindowOrder
 Key to access the default window order parameter of the system configuration.
 
const string ConfigurationKeyDefaultWindowStyle
 Key to access the default window style of the system configuration.
 
const string ConfigurationKeyDefaultWindowTitle
 Key to access the default window title of the system configuration.
 
const string ConfigurationKeyDefaultWindowWidth
 Key to access the default window width parameter of the system configuration.
 
const string ConfigurationKeyDefaultWindowX
 Key to access the default window X coordinate parameter of the system configuration.
 
const string ConfigurationKeyDefaultWindowY
 Key to access the default window Y coordinate parameter of the system configuration.
 
const string ConfigurationKeyEGLContextClientVersion
 
const string ConfigurationKeyEGLEnumerateConfigurations
 
const string ConfigurationKeyEGLGraphicsFormatID
 
const string ConfigurationKeyEGLIMGContextPriority
 Key to access the EGL IMG context priority of the system configuration.
 
const string ConfigurationKeyEGLSurfaceType
 
const string ConfigurationKeyQnxContextType
 
const string ConfigurationKeyQnxEnableSlogger2
 
const string ConfigurationKeyQnxEnumerateDisplays
 
const string ConfigurationKeyQnxPipelineID
 
const string ConfigurationKeyQnxSlogger2MaxRetries
 
const string ConfigurationKeyQnxSlogger2VerbosityLevel
 
const string ConfigurationKeySurfaceColorSpace
 
const string ConfigurationKeyWaylandInputMode
 Key to access the Wayland immediate input mode of the system configuration.
 
const string ConfigurationKeyWaylandIviLayerId
 Key to access the IVI layer ID of the system configuration.
 
const string ConfigurationKeyWaylandIviLayerOpacity
 Key to access the IVI layer opacity of the system configuration.
 
const string ConfigurationKeyWaylandIviLayerVisibility
 Key to access the IVI layer visibility of the system configuration.
 
const string ConfigurationKeyWaylandIviSurfaceId
 Key to access the IVI surface ID of the system configuration.
 
const string ConfigurationKeyWaylandIviSurfaceOpacity
 Key to access the IVI surface opacity of the system configuration.
 
const string ConfigurationKeyWaylandIviSurfaceVisibility
 Key to access the IVI surface visibility of the system configuration.
 
const string ConfigurationKeyWaylandShell
 Key to access the Wayland shell of the system configuration.
 
const string ConfigurationKeyWGLGraphicsFormatID
 
const string ConfigurationKeyWin32EnumerateDisplays
 
const string ConfigurationValueSlogger2VerbosityLevelCritical
 
const string ConfigurationValueSlogger2VerbosityLevelDebug1
 
const string ConfigurationValueSlogger2VerbosityLevelDebug2
 
const string ConfigurationValueSlogger2VerbosityLevelError
 
const string ConfigurationValueSlogger2VerbosityLevelInfo
 
const string ConfigurationValueSlogger2VerbosityLevelNotice
 
const string ConfigurationValueSlogger2VerbosityLevelShutdown
 
const string ConfigurationValueSlogger2VerbosityLevelWarning
 
const auto cursorColor
 
constexpr auto cursorWidth
 
MmapMode g_platformMmapMode
 Globally available chosen mmap() strategy.
 
constexpr int GraphicsBlendModeAdditive
 Additive blend mode.
 
constexpr int GraphicsBlendModeAdvancedMultiply
 Advanced multiply blend mode.
 
constexpr int GraphicsBlendModeAlpha
 Legacy blend mode.
 
constexpr int GraphicsBlendModeClear
 Clear blend mode.
 
constexpr int GraphicsBlendModeColorBurn
 Color Burn blend mode.
 
constexpr int GraphicsBlendModeColorDodge
 Color Dodge blend mode.
 
constexpr int GraphicsBlendModeDarken
 Darken blend mode.
 
constexpr int GraphicsBlendModeDestinationAtop
 Destination Atop blend mode.
 
constexpr int GraphicsBlendModeDestinationIn
 Destination In blend mode.
 
constexpr int GraphicsBlendModeDestinationOut
 Destination Out blend mode.
 
constexpr int GraphicsBlendModeDestinationOver
 Destination Over blend mode.
 
constexpr int GraphicsBlendModeDifference
 Difference blend mode.
 
constexpr int GraphicsBlendModeExclusion
 Exclusion blend mode.
 
constexpr int GraphicsBlendModeExclusiveOr
 Exclusive Or blend mode.
 
constexpr int GraphicsBlendModeHardLight
 Hard Light blend mode.
 
constexpr int GraphicsBlendModeHSLColor
 HSL Color blend mode.
 
constexpr int GraphicsBlendModeHSLHue
 HSL Hue blend mode.
 
constexpr int GraphicsBlendModeHSLLuminosity
 HSL Luminosity blend mode.
 
constexpr int GraphicsBlendModeHSLSaturation
 HSL Saturation blend mode.
 
constexpr int GraphicsBlendModeLighten
 Lighten blend mode.
 
constexpr int GraphicsBlendModeMixedAlpha
 Mixed Alpha blend mode.
 
constexpr int GraphicsBlendModeMultiply
 Multiply blend mode.
 
constexpr int GraphicsBlendModeOpaque
 Opaque blend mode.
 
constexpr int GraphicsBlendModeOverlay
 Overlay blend mode.
 
constexpr int GraphicsBlendModePremultipliedAlpha
 Premultiplied Alpha blend mode - the default and recommend mode for alpha blending.
 
constexpr int GraphicsBlendModeScreen
 Screen blend mode.
 
constexpr int GraphicsBlendModeSoftLight
 Soft Light blend mode.
 
constexpr int GraphicsBlendModeSourceAtop
 Source Atop blend mode.
 
constexpr int GraphicsBlendModeSourceIn
 Source In blend mode.
 
constexpr int GraphicsBlendModeSourceOut
 Source Out blend mode.
 
const NativeEventHandle invalidEventHandle
 
constexpr unsigned int InvalidTouchId
 Invalid touch point identifier.
 
const array< string_view, 471 > luaCoreLib
 
const string_view luaRequirements
 
const NativeDeploymentTarget NativeDeploymentTargetDefault
 The default native deployment target.
 
static constexpr uint16_t s_expressionValidatorBaseValueEngineInternal
 Expression operations from this index upwards are internal to Kanzi Engine.
 
static constexpr uint16_t s_expressionValidatorBaseValueProcessorInternal
 Binding processor operations from this index upwards are special cases in Kanzi Engine.
 
constexpr auto selectionCaretHitTestAreaWidth
 Sets on the left and right side of each text selection caret the width of the hit test area for that caret in pixels.
 
constexpr auto selectionIndicatorRadius
 
const int Slog2DefaultPageCount
 
const uint32_t Slog2UnlimitedRetries
 
const string SystemConfigurationKeyMmapMode
 
const string SystemConfigurationValueMmapDefault
 
const string SystemConfigurationValueMmapEager
 
const string SystemConfigurationValueMmapLazy
 
const ColorRGBA ThemeBlue
 
const ColorRGBA ThemeGray
 
const ColorRGBA ThemeGreen
 
const ColorRGBA ThemeOrange
 
const ColorRGBA ThemeRed
 
const ColorRGBA ThemeYellow
 
Default Stages.
Stage InputStage
 Stage for handling input events.
 
Stage UserStage
 Stage for executing your application code.
 
Stage AnimateStage
 Stage for ticking animations.
 
Stage LayoutStage
 Stage for laying out the nodes.
 
Stage RenderStage
 Stage for rendering the nodes.
 
Stage PresentStage
 Stage for presenting the nodes.
 

Typedef Documentation

◆ ActionSharedPtr

◆ ActionWeakPtr

◆ ActionContainer

◆ ActionConstIterator

◆ ActionBaseSharedPtr

◆ ActionBaseWeakPtr

◆ AbstractBindingRuntimeSharedPtr

◆ ApplyActionSharedPtr

◆ AbstractAnimationSharedPtr

◆ AnimationResourceSharedPtr

◆ BoolLinearFromToAnimation

◆ BoolLinearFromToAnimationSharedPtr

◆ FloatLinearFromToAnimation

◆ FloatLinearFromToAnimationSharedPtr

◆ ColorRGBALinearFromToAnimation

◆ ColorRGBALinearFromToAnimationSharedPtr

◆ FloatCustomFromToAnimation

◆ FloatCustomFromToAnimationSharedPtr

◆ ResourceSharedPtr

Resource shared pointer type.

◆ BoolKeyframeAnimation

◆ BoolKeyframeAnimationSharedPtr

◆ IntKeyframeAnimation

◆ IntKeyframeAnimationSharedPtr

◆ FloatKeyframeAnimation

◆ FloatKeyframeAnimationSharedPtr

◆ Vector2KeyframeAnimation

◆ Vector2KeyframeAnimationSharedPtr

◆ Vector3KeyframeAnimation

◆ Vector3KeyframeAnimationSharedPtr

◆ Vector4KeyframeAnimation

◆ Vector4KeyframeAnimationSharedPtr

◆ ColorRGBAKeyframeAnimation

◆ ColorRGBAKeyframeAnimationSharedPtr

◆ StringKeyframeAnimation

◆ StringKeyframeAnimationSharedPtr

◆ ResourceIDKeyframeAnimation

◆ ResourceIDKeyframeAnimationSharedPtr

◆ MorphWeightTimelineSharedPtr

◆ MorphWeightTimelinePlaybackSharedPtr

◆ ParallelTimelineSharedPtr

◆ ParallelTimelinePlaybackSharedPtr

◆ PreviewTimelineSharedPtr

◆ PreviewTimelinePlaybackSharedPtr

◆ PropertyAnimationTimelineSharedPtr

◆ PropertyAnimationTimelinePlaybackSharedPtr

◆ PropertyFieldAnimationTimelineSharedPtr

◆ PropertyFieldAnimationTimelinePlaybackSharedPtr

◆ TimelineSharedPtr

◆ TimelinePlaybackSharedPtr

◆ TimelineClockSharedPtr

◆ TimelineResourceSharedPtr

◆ BoolAnimation

◆ BoolAnimationSharedPtr

◆ IntAnimation

◆ IntAnimationSharedPtr

◆ FloatAnimation

◆ FloatAnimationSharedPtr

◆ ColorRGBAAnimation

◆ ColorRGBAAnimationSharedPtr

◆ Vector2Animation

◆ Vector2AnimationSharedPtr

◆ Vector3Animation

◆ Vector3AnimationSharedPtr

◆ Vector4Animation

◆ Vector4AnimationSharedPtr

◆ StringAnimation

◆ StringAnimationSharedPtr

◆ ResourceIDAnimation

◆ ResourceIDAnimationSharedPtr

◆ SRTValue2DAnimation

◆ SRTValue2DAnimationSharedPtr

◆ SRTValue3DAnimation

◆ SRTValue3DAnimationSharedPtr

◆ FramebufferSharedPtr

Framebuffer shared pointer type.

◆ MaterialBrushSharedPtr

Shared pointer definition.

◆ ScreenSharedPtr

Screen shared pointer.

◆ SystemConfiguration

◆ SystemProperties

typedef vector<string_view> kanzi::SystemProperties

Read-only values from the system.

◆ GeometrySharedPtr

Geometry shared pointer type.

◆ AbstractBindingSharedPtr

Abstract binding shared pointer type.

◆ BindingHostConceptSharedPtr

◆ BindingHostConceptWeakPtr

◆ BindingLookupContextPtr

◆ BindingSourceRuntimePtr

Binding source runtime pointer type.

◆ BindingTargetRuntimePtr

Binding target runtime unique pointer type.

◆ AbstractBindingRuntimeWeakPtr

◆ AbstractExpressionValueSourceSharedPtr

Abstract expression value source shared pointer type.

◆ AbstractExpressionValueSourceRuntimePtr

Abstract expression value source unique pointer type.

◆ AnimationBindingProcessorSharedPtr

Animation binding processor shared pointer type.

◆ AnimationBindingProcessorRuntimePtr

◆ BindingSharedPtr

Binding shared pointer type.

◆ BindingBaseSharedPtr

◆ NodeSharedPtr

Node shared pointer.

Alias for shared pointer of Node.

◆ RenderPassSharedPtr

RenderPass shared pointer type.

◆ BindingProcessorSharedPtr

◆ ObjectSharedPtr

Object shared pointer type.

◆ BindingProcessorRuntimePtr

◆ BindingRuntimeSharedPtr

◆ BindingSourcePtr

Binding source unique pointer type.

◆ CallbackBindingProcessorSharedPtr

◆ CallbackProcessorRuntimePtr

◆ NodeWeakPtr

Alias for weak pointer of Node.

◆ DataSourceExpressionValueSourceSharedPtr

◆ ExpressionBindingSharedPtr

◆ ExpressionBindingProcessorSharedPtr

Expression binding processor shared pointer type.

◆ ExpressionBindingRuntimeSharedPtr

◆ InstructionBindingProcessorRuntimePtr

◆ IteratorRangeSharedPtr

Iterator iterator shared pointer type.

◆ IteratorRangeWeakPtr

Iterator iterator weak pointer type.

◆ ImmutableIteratorRangeSharedPtr

◆ ManualBindingSharedPtr

Manual binding shared pointer type.

◆ ManualBindingRuntimeSharedPtr

ManualBindingRuntime shared pointer type.

Manual binding runtime shared pointer type.

◆ ObjectPropertyExpressionValueSourceSharedPtr

◆ PropertyObjectWeakPtr

◆ PropertyAccessRangeSharedPtr

Property access range shared pointer type.

◆ IndexedPropertyAccessRangeSharedPtr

Indexed property access range shared pointer type.

◆ PropertyObjectSharedPtr

◆ RangeAccumulateBindingProcessorSharedPtr

Iterator begin binding processor shared pointer type.

◆ RangeAccumulateBindingProcessorRuntimePtr

◆ RangeBindingProcessorSharedPtr

◆ RangeBindingProcessorRuntimePtr

◆ MaterialSharedPtr

Material shared pointer type.

◆ RenderPropertyExpressionValueSourceSharedPtr

◆ ResourceBindingProcessorSharedPtr

Resource binding processor shared pointer type.

◆ ResourceBindingProcessorRuntimePtr

◆ ImmutableSplitStringRangeSharedPtr

Immutable split string range shared pointer type.

◆ SplitStringRangeSharedPtr

Split string range shared pointer type.

◆ ToSourceBindingSharedPtr

◆ ToSourceBindingRuntimeSharedPtr

◆ TwoWayBindingSharedPtr

◆ TwoWayBindingRuntimeSharedPtr

◆ ValueRangeSharedPtr

Value iterator shared pointer type.

◆ ValueRangeWeakPtr

Value iterator weak pointer type.

◆ VariableBindingHostSharedPtr

Shared pointer type for variable binding host.

◆ VariableExpressionValueSourceSharedPtr

◆ BitmapImageSharedPtr

Image shared pointer type.

◆ BitmapImageUniquePtr

Image unique pointer type.

◆ BitmapImageVector

Image shared pointer vector type.

◆ ConditionSharedPtr

◆ ConditionContainer

◆ ConditionConstIterator

◆ ExpressionConditionSharedPtr

◆ BinaryResourceSharedPtr

◆ TextResourceSharedPtr

Text resource shared pointer.

◆ DataObjectSharedPtr

DataObject shared pointer type.

◆ DataContextSharedPtr

◆ DataObjectBoolSharedPtr

◆ DataObjectIntSharedPtr

◆ DataObjectRealSharedPtr

◆ DataObjectStringSharedPtr

◆ DataObjectWeakPtr

◆ DataObjectEnumBaseSharedPtr

◆ DataObjectListSharedPtr

◆ DataSourceSharedPtr

◆ DataSourceWeakPtr

◆ PatchingNotificationHandlerSharedPtr

◆ ModuleSharedPtr

◆ GraphicsOutputSharedPtr

◆ EventSourceSharedPtr

EventSource shared pointer type.

◆ NodeEffect2DSharedPtr

◆ BlurEffect2DSharedPtr

Blur effect shared pointer type.

◆ TypedFloatValueRange

◆ TypedFloatValueRangeSharedPtr

◆ BlurEffectRenderer2DUniquePtr

Blur effect renderer unique pointer type.

◆ EffectStack2DSharedPtr

Effect stack shared pointer type.

◆ NodeEffectRenderer2DSharedPtr

◆ EffectStackRenderer2DUniquePtr

◆ MaskEffect2DSharedPtr

Mask effect shared pointer type.

◆ MaskEffectRenderer2DUniquePtr

Mask effect renderer unique pointer type.

◆ OutlineEffect2DSharedPtr

◆ OutlineEffectRenderer2DUniquePtr

◆ ShadowEffect2DSharedPtr

Shadow effect shared pointer type.

◆ ShadowEffectRenderer2DUniquePtr

Shadow effect renderer unique pointer type.

◆ TextureSharedPtr

Texture shared pointer type.

◆ FontLoaderPtr

◆ TextShaperPtr

◆ FontFamilySharedPtr

◆ FontFileSharedPtr

◆ BitmapFontLoaderPtr

◆ FontEnginePluginSharedPtr

◆ GlyphCacheManagerPtr

◆ FontRuntimeSharedPtr

◆ GlyphCacheSharedPtr

Glyph cache shared pointer type.

◆ GlyphCacheUniquePtr

Glyph cache unique pointer type.

◆ GlyphKey

Key type of a glyph cache map.

GlyphKey type is a combination of the glyph index of the glyph inside the font and the hinting preference of that font.

◆ WindowedGraphicsOutputSharedPtr

◆ BrushSharedPtr

Brush shared pointer.

◆ BrushRendererPtr

Brush renderer unique pointer.

◆ ColorBrushSharedPtr

◆ CompositionBrushSharedPtr

Shared pointer type.

◆ RenderbufferSharedPtr

Renderbuffer shared pointer type.

◆ CompositionStackPtr

Composition stack shared pointer.

◆ ContentBrushSharedPtr

Shared pointer type.

◆ NativeFramebufferHandle

◆ NativeTextureHandle

◆ NullBrushSharedPtr

◆ SurfaceSharedPtr

Surface shared pointer type.

◆ TextureBrushSharedPtr

Shared pointer definition.

◆ ViewportRectangle

Viewport rectangle definition.

◆ BlitRenderPassSharedPtr

◆ ClearRenderPassSharedPtr

◆ CombinerObjectSourceSharedPtr

Combiner object source shared pointer type.

◆ CombinerObjectSourceRuntimeSharedPtr

Combiner object source runtime shared pointer type.

◆ FramebufferPtr

◆ CompositionTargetRenderPassSharedPtr

◆ ContainsPropertyFilterSharedPtr

Contains Property Filter shared pointer type.

◆ ContainsPropertyFilterRuntimeSharedPtr

Contains property node filter runtime shared pointer type.

◆ CubeMapRenderPassSharedPtr

◆ Node3DSharedPtr

Node3D shared pointer type.

◆ Node3DWeakPtr

Node3D weak pointer type.

◆ DistanceFilterSharedPtr

Distance filter shared pointer type.

◆ DistanceFilterRuntimeSharedPtr

Frustum cull filter runtime shared pointer type.

◆ FrustumCullFilterRuntimeSharedPtr

Frustum cull filter runtime shared pointer type.

◆ NodeListSharedPtr

NodeList shared pointer type.

◆ ObjectSourceRuntimeSharedPtr

Shared pointer type for object source runtime.

◆ DrawObjectsRenderPassSharedPtr

◆ DrawObjectsWithMaterialRenderPassSharedPtr

◆ FrustumCullFilterSharedPtr

Frustum cull filter shared pointer type.

◆ CameraSharedPtr

CameraNode shared pointer.

◆ CameraWeakPtr

CameraNode weak pointer.

◆ GatherLightsRenderPassSharedPtr

◆ GatherNearestLightsRenderPassSharedPtr

◆ MeshAttributeCollection

◆ MeshAttributeCollectionIterator

typedef MeshAttributeCollection::iterator kanzi::MeshAttributeCollectionIterator

◆ MeshAttributeCollectionConstIterator

typedef MeshAttributeCollection::const_iterator kanzi::MeshAttributeCollectionConstIterator

◆ ShaderAttributeCollection

◆ ShaderAttributeCollectionIterator

typedef ShaderAttributeCollection::iterator kanzi::ShaderAttributeCollectionIterator

◆ ShaderAttributeCollectionConstIterator

typedef ShaderAttributeCollection::const_iterator kanzi::ShaderAttributeCollectionConstIterator

◆ LegacyRenderPassSharedPtr

LegacyRenderpass shared pointer type.

◆ ShaderProgramSharedPtr

Shader program shared pointer type.

◆ MaterialWeakPtr

Material shared pointer type.

◆ MaterialSetupRenderPassSharedPtr

◆ MeshSharedPtr

◆ MorphSharedPtr

◆ ShaderProgramWeakPtr

Shader program weak pointer type.

◆ MorphRuntimePtr

Morph runtime unique pointer type.

◆ NodeListWeakPtr

NodeList weak pointer type.

◆ ObjectSourceSharedPtr

Object source shared pointer type.

◆ NodeListRenderPassSharedPtr

◆ ObjectSourceWeakPtr

Object source weak pointer type.

◆ ObjectTypeFilterSharedPtr

Object Type Filter shared pointer type.

◆ ObjectTypeFilterRuntimeSharedPtr

Object type filter runtime shared pointer type.

◆ PipelineStateRenderPassSharedPtr

◆ PropertyIsEqualFilterSharedPtr

Property Is Equal Filter shared pointer type.

◆ PropertyIsEqualFilterRuntimeSharedPtr

Contains property node filter runtime shared pointer type.

◆ RenderEntry3DPtr

Render state association unique pointer type.

◆ DrawObjectsRenderPassWeakPtr

◆ RenderPassConstSharedPtr

RenderPass const shared pointer type.

◆ RenderPassWeakPtr

RenderPass weak pointer type.

◆ RenderPassPrefabSharedPtr

Render pass template shared pointer type.

◆ RenderPassViewSharedPtr

◆ SortByShaderObjectSourceSharedPtr

Sort object source shared pointer type.

◆ SortByShaderObjectSourceRuntimeSharedPtr

Frustum cull filter runtime shared pointer type.

◆ SortByZObjectSourceSharedPtr

Sort object source shared pointer type.

◆ SortByZObjectSourceRuntimeSharedPtr

Frustum cull filter runtime shared pointer type.

◆ SortObjectSourceSharedPtr

Sort object source shared pointer type.

◆ TagFilterSharedPtr

Tag Filter shared pointer type.

◆ TagFilterRuntimeSharedPtr

Tag filter runtime shared pointer type.

◆ ClickManipulatorSharedPtr

◆ DragAndDropManipulatorSharedPtr

◆ FocusScopePtr

◆ FocusNavigationManipulatorSharedPtr

◆ InputManipulatorSharedPtr

◆ InputManipulatorWeakPtr

◆ KzuInputTouchPoint

◆ KeyManipulatorSharedPtr

◆ LongPressManipulatorSharedPtr

◆ MultiClickManipulatorSharedPtr

◆ NavigationManipulatorSharedPtr

◆ PanManipulatorSharedPtr

◆ PinchManipulatorSharedPtr

◆ RayPickResult

RayPick hit test result tuple.

Contains these values:

  • A shared pointer to the closest visible node that was pointed if the test is successful, an empty shared pointer otherwise.
  • The ray that passed the hit test.
  • The distance between the camera and the bounding box of the hit test node.

◆ TextInputManipulatorSharedPtr

◆ InputMethodSharedPtr

◆ InputMethodBackendSharedPtr

◆ InputMethodWeakPtr

◆ UrlContainer

typedef unordered_set<string> kanzi::UrlContainer

◆ MainLoopTaskToken

Type alias for an opaque handle to a MainLoopScheduler task.

◆ MainLoopTimerToken

Type alias for an opaque handle to a MainLoopScheduler timer.

◆ MainLoopProfilerSharedPtr

Alias for shared pointer to Main Loop Profiler.

◆ MainLoopProfilingScopeToken

Alias for token used to identify a main loop profiling scope.

◆ EmptyNode2DSharedPtr

◆ EmptyNode3DSharedPtr

◆ Image2DSharedPtr

Image2D shared pointer type.

◆ Instantiator3DSharedPtr

Instantiator3DNode shared pointer.

◆ LightSharedPtr

Light shared pointer type.

◆ LightWeakPtr

Light weak pointer type.

◆ LevelOfDetail3DSharedPtr

◆ Model3DSharedPtr

Model3D shared pointer type.

◆ InputManipulatorBaseSharedPtr

◆ NodeComponentSharedPtr

◆ ResourceDictionarySharedPtr

Resource dictionary shared pointer.

◆ NodeConstSharedPtr

Alias for shared pointer of const Node.

◆ NodeConstWeakPtr

Alias for weak pointer of const Node.

◆ Node2DSharedPtr

◆ Node2DConstSharedPtr

◆ Node2DWeakPtr

◆ Node3DConstSharedPtr

Node3D const shared pointer type.

◆ NodeEffectRenderer2DUniquePtr

Node effect unique pointer type.

◆ NodeCompositor2DPtr

◆ NodeVisual2DPtr

◆ PortalSharedPtr

◆ ProgressiveRenderingViewport2DSharedPtr

◆ SceneSharedPtr

Scene shared pointer.

◆ Viewport2DSharedPtr

Viewport2D shared pointer type.

◆ Viewport3DSharedPtr

◆ NodeComponentConstSharedPtr

◆ StyleSharedPtr

Style shared pointer type.

◆ AppliedStyleEntrySharedPtr

◆ ScriptingContextSharedPtr

Alias for an opaque handle to the scripting context of an object.

◆ GLGraphicsOutputSharedPtr

◆ AbstractRangeSharedPtr

Abstract range shared pointer type.

◆ TextureWeakPtr

◆ GPUBufferUniquePtr

◆ GLSwizzleMask

◆ MeshConstSharedPtr

◆ ShaderProgramToAttributeMapSet

◆ RenderStatePropertyNotificationHandlerPtr

Render state property notification handler unique pointer type.

◆ RendererSharedPtr

◆ AttributeNameToIndex

◆ AttributeNameToIndexIterator

typedef AttributeNameToIndex::iterator kanzi::AttributeNameToIndexIterator

◆ AttributeNameToIndexConstIterator

typedef AttributeNameToIndex::const_iterator kanzi::AttributeNameToIndexConstIterator

◆ BufferObjectStreamSharedPtr

◆ LegacyGraphicsOutputSharedPtr

◆ UniqueEventPtr

◆ WindowsImeSharedPtr

◆ NativeEventHandle

◆ ResourceWeakPtr

◆ ResourceDictionarySelectorSharedPtr

◆ ReadOnlyMemoryFilePtr

◆ ResourceManagerSharedPtr

Resource manager shared pointer type.

◆ ResourceProfilerUniquePtr

The resource profiler unique ptr type.

◆ ResourceProfilingContextSharedPtr

◆ ResourceProfilingContextFactoryUniquePtr

The resource profiling context factory unique pointer type.

◆ ResourceProfilingDataSampleSharedPtr

Profiled resource shared pointer type.

◆ ProfiledLoadTaskSharedPtr

Profiled load task shared pointer type.

◆ TrajectorySharedPtr

Trajectory shared pointer type.

◆ StateManagerSharedPtr

◆ StateManagerWeakPtr

◆ NodeComponentTemplateSharedPtr

◆ DataTriggerTemplateSharedPtr

◆ DataTriggerTemplateConstSharedPtr

◆ NodeComponentTemplateConstSharedPtr

◆ NodeEffect2DConstSharedPtr

◆ NodeEffectPrefab2DSharedPtr

Node effect prefab shared pointer type.

◆ NodeEffectTemplate2DSharedPtr

◆ PrefabTemplateSharedPtr

◆ PrefabTemplateNodeSharedPtr

◆ PrefabTemplateNodeWeakPtr

◆ RenderPassTemplateSharedPtr

◆ TriggerTemplateSharedPtr

◆ TriggerTemplateConstSharedPtr

◆ TextBreakIteratorObjectPtr

◆ TextFormatPtr

Text format unique pointer.

◆ TextManagerUniquePtr

◆ TextManagerShareedPtr

◆ DataTriggerComponentSharedPtr

◆ TriggerSharedPtr

◆ byte

◆ ThreadNativeHandleType

typedef std::thread::native_handle_type kanzi::ThreadNativeHandleType

◆ default_random_engine

◆ conditional_t

◆ WriteOnlyDiskFileUniquePtr

◆ AbstractLoggerUniquePtr

Typedef of the kanzi::AbstractLogger unique pointer.

◆ CurveReparametrizationPtr

◆ RectangleFloat

Float type rectangle.

◆ RectangleInteger

Integer type rectangle.

◆ SplinePtr

Spline unique pointer type.

◆ PropertyTypeEditorInfoSharedPtr

◆ MetaObjectSharedPtr

MetaObject shared pointer type.

◆ ConstCharArrayUniquePtr

Alias for a unique_ptr to array of const char.

◆ Win32String

◆ Win32StringView

◆ ReadOnlyDiskFileUniquePtr

◆ AbstractProfilerSharedPtr

The shared pointer to the abstract profiler source.

◆ AbstractProfilerRegistry

◆ IntervalProfilerSharedPtr

The shared pointer to the interval profiler.

◆ IntervalProfilerRegistry

◆ NamedIntervalProfilerSharedPtr

The shared pointer to the interval profiler.

◆ NamedIntervalProfilerRegistry

The interval profiler registry type.

◆ StartupProfilerRegistryUniquePtr

The startup profiler registry unique ptr type.

◆ AbstractPropertyNotificationHandlerSharedPtr

Abstract property notification handler shared pointer.

◆ AbstractRangeWeakPtr

Abstract range weak pointer type.

◆ AbstractRangeLocationPtr

◆ AbstractIndexedRangeSharedPtr

◆ OptionalDynamicPropertyType

◆ IndexedViewRangeSharedPtr

◆ ViewRangeSharedPtr

◆ TimePoint

◆ ConstByteSpan

ConstByteSpan refers to constant contiguous sequence of bytes.

◆ ByteSpan

ByteSpan refers to contiguous sequence of bytes.

◆ JNI_CreateJavaVMPtr

◆ JNI_GetCreatedJavaVMsPtr

◆ ExecuteLuaActionSharedPtr

◆ LuaInstancePtr

◆ ItypeThaiDictionarySharedPtr

◆ TargetPreviewServerSharedPtr

◆ ApplyActivationActionSharedPtr

◆ ActivityElementSharedPtr

◆ ApplyPropertyActionSharedPtr

◆ DispatchMessageActionSharedPtr

◆ ForwardingActionSharedPtr

◆ ForwardingApplyActionSharedPtr

◆ MoveFocusActionSharedPtr

◆ SetPropertyActionSharedPtr

◆ TrySetFocusActionSharedPtr

◆ WriteLogActionSharedPtr

◆ Activity2DSharedPtr

◆ Activity3DSharedPtr

◆ Button2DSharedPtr

◆ Button3DSharedPtr

◆ ActivityBrowserControllerSharedPtr

◆ ActivityCodeBehindSharedPtr

◆ NodeWeakPtrContainer

◆ BindingTokenUniquePtr

◆ BindingTokenSharedPtr

◆ BindingTokenWeakPtr

◆ CodeBehindSharedPtr

◆ CodeBehindRegisterGuardSharedPtr

◆ DataSourceListItemGenerator2DSharedPtr

◆ DataSourceListItemGenerator3DSharedPtr

◆ PropertyChangedFunction

◆ ListBoxItemGenerator2DSharedPtr

◆ ListBoxItemGenerator3DSharedPtr

◆ ContentLayout2DSharedPtr

◆ ContentLayout3DSharedPtr

◆ DataDrivenExclusiveActivityHost2DSharedPtr

◆ DataDrivenExclusiveActivityHost3DSharedPtr

◆ DockLayout2DSharedPtr

◆ DockLayout3DSharedPtr

DockLayout shared pointer.

◆ ExclusiveActivityHost2DSharedPtr

◆ ExclusiveActivityHost3DSharedPtr

◆ FlowLayout2DSharedPtr

◆ FlowLayout3DSharedPtr

FlowLayout shared pointer.

◆ GridLayout2DSharedPtr

◆ GridLayout3DSharedPtr

◆ GridListBox2DSharedPtr

◆ GridListBox3DSharedPtr

◆ ListBoxItemContainer3DSharedPtr

◆ ListBoxItemContainer2DSharedPtr

◆ NinePatchImage2DSharedPtr

◆ PageSharedPtr

◆ PageWeakPtr

◆ PageHostSharedPtr

◆ PageTransitionCollectionSharedPtr

◆ ParallelActivityHost2DSharedPtr

◆ ParallelActivityHost3DSharedPtr

◆ PrefabView2DSharedPtr

Prefab view 2D shared pointer.

◆ PrefabView3DSharedPtr

Prefab view 3D shared pointer.

◆ ScrollView2DSharedPtr

◆ ScrollView3DSharedPtr

◆ Slider2DSharedPtr

Trajectory Slider shared pointer.

◆ Slider2DPresenterType

◆ Slider2DConceptImplType

◆ Slider3DSharedPtr

Trajectory Slider shared pointer.

◆ Slider3DPresenterType

◆ Slider3DConceptImplType

◆ StackLayout2DSharedPtr

Stack layout shared pointer.

◆ StackLayout3DSharedPtr

StackLayout shared pointer.

◆ TextBlock2DSharedPtr

TextLayer shared pointer.

◆ TextBlock3DSharedPtr

TextBlock shared pointer.

◆ TextBox2DSharedPtr

◆ TextBox3DSharedPtr

◆ ToggleButton2DSharedPtr

◆ ToggleButton3DSharedPtr

◆ ToggleButtonGroup2DSharedPtr

◆ ToggleButtonGroup3DSharedPtr

◆ TrajectoryLayout2DSharedPtr

TrajectoryLayout shared pointer.

◆ TrajectoryLayout3DSharedPtr

TrajectoryLayout shared pointer.

◆ TrajectoryListBox3DSharedPtr

◆ AnimationPlayerSharedPtr

◆ FloatValueAccumulatorSharedPtr

◆ IntValueAccumulatorSharedPtr

◆ PropertyDrivenAnimationPlayerSharedPtr

◆ PropertyTargetInterpolationTimelineSharedPtr

◆ PropertyFieldTargetInterpolationTimelinePlaybackSharedPtr

◆ PropertyTargetEasingInterpolatorSharedPtr

◆ PropertyTargetEasingTimelineSharedPtr

◆ PropertyTargetEasingTimelinePlaybackSharedPtr

◆ PropertyTargetInterpolationTimelinePlaybackSharedPtr

◆ PropertyTargetInterpolatorSharedPtr

◆ ClickManipulatorComponentSharedPtr

◆ KeyManipulatorComponentSharedPtr

◆ LongPressManipulatorComponentSharedPtr

◆ MultiClickManipulatorComponentSharedPtr

◆ NavigationManipulatorComponentSharedPtr

◆ PanManipulatorComponentSharedPtr

◆ DataTriggerSharedPtr

◆ MessageTriggerSharedPtr

◆ OnAttachedTriggerSharedPtr

◆ OnPropertyChangedTriggerSharedPtr

◆ TimerTriggerSharedPtr

Enumeration Type Documentation

◆ KzuTimeLineEntryPlaybackMode

Playback type of the timeline.

Enumerator
KZU_TIME_LINE_ENTRY_PLAYBACK_MODE_NORMAL 

Plays the animation timeline normally from the start to end.

KZU_TIME_LINE_ENTRY_PLAYBACK_MODE_REVERSE 

Plays the animation timeline in reverse from the end to start.

KZU_TIME_LINE_ENTRY_PLAYBACK_MODE_PINGPONG 

Plays the animation timeline first normally, then in reverse.

◆ ImageFlipAxis

Image axis to flip over.

Enumerator
FlipAxisNone 

No flipping.

FlipAxisHorizontal 

Flip horizontally.

FlipAxisVertical 

Flip vertically.

FlipAxisHorizontalAndVertical 

Flip horizontally and vertically.

◆ FontStyle

Font style options.

Since
Kanzi 3.8.0
Enumerator
Normal 

Specifies normal font style.

Italic 

Specifies italic font style.

◆ FontWeight

Font weight options.

Since
Kanzi 3.8.0
Enumerator
Thin 

Specifies the font weight Thin.

ExtraLight 

Specifies the font weight ExtraLight.

Light 

Specifies the font weight Light.

Normal 

Specifies the font weight Normal.

Medium 

Specifies the font weight Medium.

SemiBold 

Specifies the font weight SemiBold.

Bold 

Specifies the font weight Bold.

ExtraBold 

Specifies the font weight ExtraBold.

Black 

Specifies the font weight Black.

◆ FontHintingPreference

Font hinting options.

Hinting refers to the adjustments in the outline-filling process of a glyph, so that the glyph lines up within the rasterized grid.

Since
Kanzi 3.9.0
Enumerator
NoHinting 

Render text without hinting the outlines of glyphs.

NativeHinting 

Enable hinting. Prefer native hinter of the font over the auto-hinter of the rasterizer.

AutoHinting 

Enable hinting. Prefer auto-hinter of the rasterizer over the native hinter of the font.

◆ SurfaceColorSpace

Color Spaces for a surface.

Enumerator
Legacy 

Specifies a legacy, unspecified color space. Shaders are expected to output directly to desired colorspace.

Passthrough 

Specifies a passthrough color space. Shaders are expected to output directly to desired colorspace. Linear color projects are required.

sRGB 

Specifies the sRGB color space. Shaders are expected to output a linear color, which is converted to sRGB by the backend. Linear color projects are required.

◆ ColorWorkflow

The Color Workflow for an application.

Enumerator
Legacy 

Specifies the legacy color workflow.

Linear 

Specifies the Linear color workflow.

◆ GraphicsElementType

GraphicsElementType is used to specify type of element of data consumed by shaders.

An element is a scalar used to build scalars (single element), vectors (one row) and matrices (multiple rows and columns) consumed by shaders.

See also
ShaderVertexAttribute
Enumerator
GraphicsElementTypeUINT 

Unsigned integer element type.

GraphicsElementTypeSINT 

Signed integer element type.

GraphicsElementTypeFLOAT 

Floating point element type.

◆ GraphicsDataType

GraphicsDataType is used to specify type of data in textures and vertex buffers.

Enumerator
GraphicsDataTypeNone 

Indicates unused, empty or invalid data type.

GraphicsDataTypeUNORM8 

Unsigned normalized 8-bit data type.

GraphicsDataTypeSNORM8 

Signed normalized 8-bit data type.

GraphicsDataTypeUNORM16 

Unsigned normalized 16-bit data type.

GraphicsDataTypeSNORM16 

Signed normalized 16-bit data type.

GraphicsDataTypeUNORM32 

Unsigned normalized 32-bit data type.

GraphicsDataTypeSNORM32 

Signed normalized 32-bit data type.

GraphicsDataTypeUNORM_PACK16_5_6_5 

A three-component, 16-bit packed unsigned normalized data type that has a 5-bit R component in bits 11..15, a 6-bit G component in bits 5..10, and a 5-bit B component in bits 0..4.

GraphicsDataTypeCOMPRESSED 

A compressed data type, used for compressed texture formats.

GraphicsDataTypeUINT8 

8-bit unsigned integer data type.

GraphicsDataTypeSINT8 

8-bit signed integer data type.

GraphicsDataTypeUINT16 

16-bit unsigned integer data type.

GraphicsDataTypeSINT16 

16-bit signed integer data type.

GraphicsDataTypeUINT32 

32-bit unsigned integer data type.

GraphicsDataTypeSINT32 

32-bit signed integer data type.

GraphicsDataTypeSFLOAT16 

16-bit signed floating-point data type.

GraphicsDataTypeSFLOAT32 

32-bit signed floating-point data type.

GraphicsDataTypeUNORM24 

24-bit unsigned normalized data type.

GraphicsDataTypeUNORM24_UINT8 

32-bit packed data type that has 8 unsigned integer bits in the first component, and 24 unsigned normalized bits in the second component.

GraphicsDataTypeUNORM_PACK32_2_10_10_10 

A four-component, 32-bit packed unsigned normalized data type that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9.

GraphicsDataTypeSNORM_PACK32_2_10_10_10 

A four-component, 32-bit packed signed normalized data type that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9.

GraphicsDataTypeNative 

Placeholder value for GraphicsFormats that do not use the GraphicsDataType abstraction.

◆ GraphicsFormat

GraphicsFormat specifies format of graphics data used for example in textures and vertex attributes.

Enumerator
GraphicsFormatNone 

Indicates unused, empty or invalid graphics format.

GraphicsFormatLUMINANCE8_UNORM 

Single channel luminance 8-bit unsigned normalized format, one byte per pixel.

GraphicsFormatALPHA8_UNORM 

Single channel alpha 8-bit unsigned normalized format, one byte per pixel.

GraphicsFormatLUMINANCE8_ALPHA8_UNORM 

Two channel luminance and alpha 8-bit unsigned normalized format, two bytes per pixel.

GraphicsFormatR8_UNORM 

One channel red 8-bit unsigned normalized format, one byte per pixel.

Note
Requires OpenGL ES 3 or rg texture extension.
GraphicsFormatR8_UINT 

One channel red 8-bit unsigned integer format, one byte per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR8_SINT 

One channel red 8-bit signed integer format, one byte per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR8G8_UNORM 

Two channel red green 8-bit unsigned normalized format, two bytes per pixel.

Note
Requires OpenGL ES 3 or rg texture extension.
GraphicsFormatR8G8_UINT 

Two channel red green 8-bit unsigned integer format, two bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR8G8_SINT 

Two channel red green 8-bit signed integer format, two bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR8G8B8_UNORM 

Three channel RGB 8-bit unsigned normalized format, three bytes per pixel.

GraphicsFormatR8G8B8_SRGB 

Three channel RGB 8-bit unsigned normalized format in sRGB color space, three bytes per pixel.

GraphicsFormatR8G8B8_UINT 

Three channel RGB 8-bit unsigned integer format, three bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR8G8B8_SINT 

Three channel RGB 8-bit signed integer format, three bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR8G8B8A8_UNORM 

Four channel RGB and alpha 8-bit unsigned normalized format, four bytes per pixel.

GraphicsFormatR8G8B8A8_SRGB 

Four channel RGB and alpha 8-bit unsigned normalized format in sRGB color space, four bytes per pixel.

GraphicsFormatR8G8B8A8_UINT 

Four channel RGBA 8-bit unsigned integer format, four bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR8G8B8A8_SINT 

Four channel RGBA 8-bit signed integer format, four bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR16_UINT 

One channel red 16-bit unsigned integer format, two bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR16_SINT 

One channel red 16-bit signed integer format, two bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR16_SFLOAT 

One channel red 16-bit half float format, two bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatR16G16_UINT 

Two channel red green 16-bit unsigned integer format, four bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR16G16_SINT 

Two channel red green 16-bit signed integer format, four bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR16G16_SFLOAT 

Two channel red green 16-bit half float format, four bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatR16G16B16_UINT 

Three channel RGB 16-bit unsigned integer format, six bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR16G16B16_SINT 

Three channel RGB 16-bit signed integer format, six bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR16G16B16_SFLOAT 

Three channel RGB 16-bit half float format, six bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatR16G16B16A16_UINT 

Four channel RGBA 16-bit unsigned integer format, eight bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatR16G16B16A16_SINT 

Four channel RGBA 16-bit signed integer format, eight bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatR16G16B16A16_SFLOAT 

Four channel RGBA 16-bit half float format, eight bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatR5G6B5_UNORM_PACK16 

Three channel RGB 5, 6, 5-bit unsigned normalized format, two bytes per pixel.

GraphicsFormatETC1_R8G8B8_UNORM 

Three channel RGB ETC1 compressed format, 4 by 4 pixels per block, 64 bits per block.

GraphicsFormatETC2_R8G8B8_UNORM 

Three channel RGB ETC2 compressed format, 4 by 4 pixels per block, 64 bits per block.

GraphicsFormatETC2_R8G8B8A1_UNORM 

Four channel RGB and punchthrough alpha ETC2 compressed format, 4 by 4 pixels per block, 64 bits per block.

GraphicsFormatETC2_R8G8B8A8_UNORM 

Four channel RGB and alpha ETC2 compressed format, 4 by 4 pixels per block, 128 bits per block.

GraphicsFormatBC2_UNORM 

Four channel RGB and alpha DXT3 compressed format, 4 by 4 pixels per block, 128 bits per block.

See also
https://www.khronos.org/registry/gles/extensions/EXT/texture_compression_s3tc.txt
GraphicsFormatBC3_UNORM 

Four channel RGB and alpha DXT5 compressed format, 4 by 4 pixels per block, 128 bits per block, interpolated alpha.

See also
https://www.khronos.org/registry/gles/extensions/EXT/texture_compression_s3tc.txt
GraphicsFormatPVRTC1_RGB_2BPP 

Three channel RGB PVR1 compressed format, 8 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/gles/extensions/IMG/IMG_texture_compression_pvrtc.txt
GraphicsFormatPVRTC1_RGB_4BPP 

Three channel RGB PVR1 compressed format, 4 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/gles/extensions/IMG/IMG_texture_compression_pvrtc.txt
GraphicsFormatPVRTC1_RGBA_2BPP 

Four channel RGB and alpha PVR1 compressed format, 2 bits per pixel, 8 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/gles/extensions/IMG/IMG_texture_compression_pvrtc.txt
GraphicsFormatPVRTC1_RGBA_4BPP 

Four channel RGB and alpha PVR1 compressed format, 4 bits per pixel, 4 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/gles/extensions/IMG/IMG_texture_compression_pvrtc.txt
GraphicsFormatPVRTC2_RGBA_2BPP 

Four channel RGB and alpha PVR2 compressed format, 2 bits per pixel, 8 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/gles/extensions/IMG/IMG_texture_compression_pvrtc2.txt
GraphicsFormatPVRTC2_RGBA_4BPP 

Four channel RGB and alpha PVR2 compressed format, 4 bits per pixel, 4 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/gles/extensions/IMG/IMG_texture_compression_pvrtc2.txt
GraphicsFormatATC_RGB 

Three channel RGB ATC compressed format.

See also
https://www.khronos.org/registry/gles/extensions/AMD/AMD_compressed_ATC_texture.txt
GraphicsFormatATC_RGBA_EXPLICIT_ALPHA 

Four channel RGB and alpha compressed format.

See also
https://www.khronos.org/registry/gles/extensions/AMD/AMD_compressed_ATC_texture.txt
GraphicsFormatATC_RGBA_INTERPOLATED_ALPHA 

Four channel RGB and alpha compressed format.

See also
https://www.khronos.org/registry/gles/extensions/AMD/AMD_compressed_ATC_texture.txt
GraphicsFormatD16_UNORM 

Single channel depth 16-bit unsigned normalized format.

See also
https://www.khronos.org/registry/gles/extensions/OES/OES_depth_texture.txt
GraphicsFormatD24_UNORM 

Single channel depth 24-bit unsigned normalized format.

GraphicsFormatD32_SFLOAT 

Single channel depth 32-bit float format.

GraphicsFormatD24_UNORM_S8_UINT 

Two channel depth stencil format.

GraphicsFormatS8_UINT 

Single channel stencil 8-bit unsigned integer format.

GraphicsFormatASTC_4x4_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 4x4 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_4x4_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 4x4 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_5x4_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 5x4 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_5x4_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 5x4 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_5x5_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 5x5 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_5x5_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 5x5 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_6x5_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 6x5 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_6x5_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 6x5 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_6x6_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 6x6 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_6x6_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 6x6 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_8x5_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 8x5 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_8x5_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 8x5 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_8x6_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 8x6 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_8x6_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 8x6 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_8x8_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 8x8 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_8x8_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 8x8 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_10x5_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 10x5 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_10x5_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 10x5 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_10x6_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 10x6 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_10x6_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 10x6 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_10x8_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 10x8 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_10x8_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 10x8 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_10x10_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 10x10 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_10x10_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 10x10 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_12x10_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 12x10 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_12x10_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 12x10 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_12x12_UNORM_BLOCK 

Unsigned normalized ASTC-compressed packed 12x12 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatASTC_12x12_SRGB_BLOCK 

sRGB-corrected ASTC-compressed packed 12x12 block format.

Note
Do not change the ordering of ASTC entries in this enum.
GraphicsFormatALPHA1_LUMINANCE7_UNORM 

Two channel 1-bit alpha and 7-bit luminance unsigned normalized format, 8 bits per pixel.

GraphicsFormatALPHA4_LUMINANCE4_UNORM 

Two channel 4-bit alpha and 4-bit luminance unsigned normalized format, 8 bits per pixel.

GraphicsFormatALPHA8_LUMINANCE8_UNORM 

Two channel alpha and luminance 8-bit unsigned normalized format, 16 bits per pixel.

GraphicsFormatALPHALUMINANCE1_UNORM 

Two channel aliased single 1-bit alpha/luminance component unsigned normalized texture only format, 1 bit per pixel.

GraphicsFormatALPHALUMINANCE2_UNORM 

Two channel aliased single 2-bit alpha/luminance component unsigned normalized texture only format, 2 bits per pixel.

GraphicsFormatALPHALUMINANCE4_UNORM 

Two channel aliased single 4-bit alpha/luminance component unsigned normalized texture only format, 4 bits per pixel.

GraphicsFormatALPHALUMINANCE8_UNORM 

Two channel aliased single 8-bit alpha/luminance component unsigned normalized texture only format, 8 bits per pixel.

GraphicsFormatA1R5G5B5_UNORM 

Four channel 1-bit alpha and 5-bit RGB unsigned normalized format, 16 bits per pixel.

GraphicsFormatR5G5B5A1_UNORM 

Four channel 5-bit RGB and 1-bit alpha unsigned normalized format, 16 bits per pixel.

GraphicsFormatA4R4G4B4_UNORM 
GraphicsFormatR4G4B4A4_UNORM 

Four channel 4-bit RGB and 4-bit alpha unsigned normalized format, 16 bits per pixel.

GraphicsFormatA8R8G8B8_UNORM 

Four channel ARGB 8-bit unsigned normalized format, 32 bits per pixel.

GraphicsFormatCLUT8_UINT 

Single component 8-bit unsigned integer texture only color lookup table format, 8 bits per component.

GraphicsFormatCLUT4_UINT 

Single component 4-bit unsigned integer texture only color lookup table format, 4 bits per component.

GraphicsFormatCLUT2_UINT 

Single component 2-bit unsigned integer texture only color lookup table format, 2 bits per component.

GraphicsFormatCLUT1_UINT 

Single component 1-bit unsigned integer texture only color lookup table format, 1 bit per component.

GraphicsFormatR8_SNORM 

One channel red 8-bit signed normalized format, one byte per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatR32_UINT 

One channel red 32-bit unsigned integer format, four bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR32_SINT 

One channel red 32-bit signed integer format, four byte per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR32_SFLOAT 

One channel red 32-bit float format, four bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatR8G8_SNORM 

Two channel red green 8-bit signed normalized format, two bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatR32G32_UINT 

Two channel red green 32-bit unsigned integer format, eight bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR32G32_SINT 

Two channel red green 32-bit signed integer format, eight bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR32G32_SFLOAT 

Two channel red green 32-bit float format, eight bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatR8G8B8_SNORM 

Three channel RGB 8-bit signed normalized format, three bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatR32G32B32_UINT 

Three channel RGB 32-bit unsigned integer format, twelve bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR32G32B32_SINT 

Three channel RGB 32-bit signed integer format, twelve bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatR32G32B32_SFLOAT 

Three channel red green blue 32-bit float format, twelve bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatR8G8B8A8_SNORM 

Four channel RGB and alpha 8-bit signed normalized format, four bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatR32G32B32A32_UINT 

Four channel RGBA 32-bit signed integer format, sixteen bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatR32G32B32A32_SINT 

Four channel RGBA 32-bit signed integer format, sixteen bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatR32G32B32A32_SFLOAT 

Four channel RGB and alpha 32-bit float format, sixteen bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatR16_UNORM 

Single channel Red 16-bit unsigned normalized, two bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatR16_SNORM 

Single channel Red 16-bit signed normalized, two bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatR16G16_UNORM 

Two channel RG 16-bit unsigned normalized, four bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatR16G16_SNORM 

Two channel RG 16-bit signed normalized, four bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatR16G16B16_UNORM 

Three channel RGB 16-bit unsigned normalized, six bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatR16G16B16_SNORM 

Three channel RGB 16-bit signed normalized, six bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatR16G16B16A16_UNORM 

Four channel RGBA 16-bit unsigned normalized, eight bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatR16G16B16A16_SNORM 

Four channel RGBA 16-bit signed normalized, eight bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatETC2_R8G8B8_SRGB 

Three channel sRGB ETC2 compressed format, 4 by 4 pixels per block, 64 bits per block.

GraphicsFormatETC2_R8G8B8A1_SRGB 

Four channel sRGB and punchthrough alpha ETC2 compressed format, 4 by 4 pixels per block, 64 bits per block.

GraphicsFormatETC2_R8G8B8A8_SRGB 

Four channel sRGB and alpha ETC2 compressed format, 4 by 4 pixels per block, 128 bits per block.

GraphicsFormatPVRTC1_SRGB_2BPP 

Three channel SRGB PVR1 compressed format, 8 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_pvrtc_sRGB.txt
GraphicsFormatPVRTC1_SRGB_4BPP 

Three channel SRGB PVR1 compressed format, 4 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_pvrtc_sRGB.txt
GraphicsFormatPVRTC1_SRGBA_2BPP 

Four channel SRGB and alpha PVR1 compressed format, 2 bits per pixel, 8 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_pvrtc_sRGB.txt
GraphicsFormatPVRTC1_SRGBA_4BPP 

Four channel SRGB and alpha PVR1 compressed format, 4 bits per pixel, 4 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_pvrtc_sRGB.txt
GraphicsFormatPVRTC2_SRGBA_2BPP 

Four channel SRGB and alpha PVR2 compressed format, 2 bits per pixel, 8 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_pvrtc_sRGB.txt
GraphicsFormatPVRTC2_SRGBA_4BPP 

Four channel SRGB and alpha PVR2 compressed format, 4 bits per pixel, 4 by 4 pixels per block, 64 bits per block.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_pvrtc_sRGB.txt
GraphicsFormatA8R8G8B8_UINT 

Four channel ARGB 8-bit unsigned integer format, four bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatA8R8G8B8_SINT 

Four channel ARGB 8-bit signed integer format, four bytes per pixel.

Note
Requires OpenGL ES 3.
GraphicsFormatA16R16G16B16_UINT 

Four channel ARGB 16-bit unsigned integer format, eight bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatA16R16G16B16_SINT 

Four channel ARGB 16-bit signed integer format, eight bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatA16R16G16B16_SFLOAT 

Four channel ARGB 16-bit half float format, eight bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatA8R8G8B8_SNORM 

Four channel ARGB 8-bit signed normalized format, four bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatA32R32G32B32_UINT 

Four channel ARGB 32-bit unsigned integer format, sixteen bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatA32R32G32B32_SINT 

Four channel ARGB 32-bit signed integer format, sixteen bytes per pixel.

Note
Requires OpenGL ES 3
GraphicsFormatA32R32G32B32_SFLOAT 

Four channel ARGB 32-bit float format, sixteen bytes per pixel.

Note
Requires OpenGL ES 3 or ES 2 with extensions.
GraphicsFormatA16R16G16B16_UNORM 

Four channel ARGB 16-bit unsigned normalized format, eight bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatA16R16G16B16_SNORM 

Four channel ARGB 16-bit signed normalized format, eight bytes per pixel.

See also
https://www.khronos.org/registry/OpenGL/extensions/EXT/EXT_texture_norm16.txt
GraphicsFormatGlRangeBegin 

The first format in the range of valid, usable GL graphics formats.

GraphicsFormatGlRangeEnd 

The last format in the range of valid, usable GL graphics formats.

GraphicsFormatR_DRW2D_PIXELFORMAT_ALPHA8 

Single channel alpha 8-bit unsigned normalized framebuffer only format, 8 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_LUM8 

Single channel luminance 8-bit unsigned normalized framebuffer only format, 8 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_AL17 

Two channel 1-bit alpha and 7-bit luminance unsigned normalized format, 8 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_AL44 

Two channel 4-bit alpha and 4-bit luminance unsigned normalized format, 8 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_AL88 

Two channel alpha and luminance 8-bit unsigned normalized format, 16 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_AL1 

Two channel aliased single 1-bit alpha/luminance component unsigned normalized texture only format, 1 bit per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_AL2 

Two channel aliased single 2-bit alpha/luminance component unsigned normalized texture only format, 2 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_AL4 

Two channel aliased single 4-bit alpha/luminance component unsigned normalized texture only format, 4 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_AL8 

Two channel aliased single 8-bit alpha/luminance component unsigned normalized texture only format, 8 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_RGB565 

Three channel RGB 5, 6, 5-bit unsigned normalized format, 16 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_ARGB1555 

Four channel 1-bit alpha and 5-bit RGB unsigned normalized format, 16 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_RGBA5551 

Four channel 5-bit RGB and 1-bit alpha unsigned normalized format, 16 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_ARGB4444 

Four channel 4-bit alpha and 4-bit RGB unsigned normalized format, 16 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_RGBA4444 

Four channel 4-bit RGB and 4-bit alpha unsigned normalized format, 16 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_ARGB8888 

Four channel ARGB 8-bit unsigned normalized format, 32 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_RGBA8888 

Four channel RGBA 8-bit unsigned normalized format, 32 bits per pixel.

GraphicsFormatR_DRW2D_PIXELFORMAT_CLUT_8 

Single component 8-bit unsigned integer texture only color lookup table format, 8 bits per component.

GraphicsFormatR_DRW2D_PIXELFORMAT_CLUT_4 

Single component 4-bit unsigned integer texture only color lookup table format, 4 bits per component.

GraphicsFormatR_DRW2D_PIXELFORMAT_CLUT_2 

Single component 2-bit unsigned integer texture only color lookup table format, 2 bits per component.

GraphicsFormatR_DRW2D_PIXELFORMAT_CLUT_1 

Single component 1-bit unsigned integer texture only color lookup table format, 1 bit per component.

GraphicsFormatFullRangeBegin 

The first format in the full range of graphics formats, including invalid values.

GraphicsFormatFullRangeEnd 

The last format in the full range of graphics formats, including invalid values.

◆ BlendFactor

Blend mode representation.

Allows all possible combinations for a blend mode to be constructed, but also has stock values for most common blend modes. Full blend mode consists of 4 components:

  • Factor for source color.
  • Factor for source alpha.
  • Factor for destination color.
  • Factor for destination alpha.
  • Equation for color.
  • Equation for alpha.

The factors only have 15 different values, which means they require 8 bits each. Equations have only 6 values. This means the complete blend mode setting can be packed into a 32-bit integer. Blend factor.

Since
Kanzi 3.9.1
Enumerator
BlendFactorZero 

Multiplies by zero.

BlendFactorOne 

Multiplies by one.

BlendFactorSrcColor 

Multiplies component-wise by the source color.

BlendFactorOneMinusSrcColor 

Multiplies component-wise by one minus source color.

BlendFactorDstColor 

Multiplies component-wise by destination color.

BlendFactorOneMinusDstColor 

Multiplies component-wise by one minus destination color.

BlendFactorSrcAlpha 

Multiplies by source alpha.

BlendFactorOneMinusSrcAlpha 

Multiplies by one minus source alpha.

BlendFactorDstAlpha 

Multiplies by destination alpha.

BlendFactorOneMinusDstAlpha 

Multiplies by one minus destination alpha.

BlendFactorConstantColor 

Multiplies component-wise by constant color.

This requires a constant blend color to be specified.

BlendFactorOneMinusConstantColor 

Multiplies component-wise by one minus constant color.

This requires a constant blend color to be specified.

BlendFactorConstantAlpha 

Multiplies by constant alpha.

This requires a constant blend color to be specified.

BlendFactorOneMinusConstantAlpha 

Multiplies by one minus constant alpha.

This requires a constant blend color to be specified.

BlendFactorSrcAlphaSaturate 

Multiplies by the smaller of source alpha and one minus destination alpha.

BlendFactorMask 

Blend factor mask.

◆ BlendEquation

Blend equation.

Since
Kanzi 3.9.1
Enumerator
BlendEquationNone 

Disables blending.

BlendEquationAdd 

Adds the source and destination.

BlendEquationSubtract 

Subtracts the destination from source.

BlendEquationReverseSubtract 

Subtracts the source from destination.

BlendEquationMin 

Returns the minimum of the source and destination.

BlendEquationMax 

Returns the maximum of the source and destination.

BlendEquationMask 

Blend equation mask.

◆ BlendEquationAdvanced

Specifies the advanced blend modes.

Since
Kanzi 3.9.6
Enumerator
BlendEquationAdvancedNone 

Disables advanced blending.

BlendEquationMultiply 

Multiply.

BlendEquationOverlay 

Overlay.

BlendEquationDarken 

Darken.

BlendEquationLighten 

Lighten.

BlendEquationColorBurn 

Color Burn.

BlendEquationColorDodge 

Color Dodge.

BlendEquationHardLight 

Hard Light.

BlendEquationSoftLight 

Soft Light.

BlendEquationDifference 

Difference.

BlendEquationExclusion 

Exclusion.

BlendEquationHSLHue 

HSL Hue.

BlendEquationHSLSaturation 

HSL Saturation.

BlendEquationHSLColor 

HSL Color.

BlendEquationHSLLuminosity 

HSL Luminosity.

◆ BlendComponentBitShift

Blend component bit shifts.

Kanzi uses blend component bit shifts internally.

Since
Kanzi 3.9.1
Enumerator
BlendComponentBitShiftSrcColor 

Source color bit shift.

BlendComponentBitShiftSrcAlpha 

Source alpha bit shift.

BlendComponentBitShiftDstColor 

Destination color bit shift.

BlendComponentBitShiftDstAlpha 

Destination alpha bit shift.

BlendComponentBitShiftEquationColor 

Color blend equation bit shift.

BlendComponentBitShiftEquationAlpha 

Alpha blend equation bit shift.

BlendComponentBitShiftEquationAdvanced 

Advanced blend equation bit shift.

◆ BlendSrcColorFactor

Blend factor for source color.

Since
Kanzi 3.9.1
Enumerator
BlendSrcColorFactorZero 

Multiplies the source color by zero.

BlendSrcColorFactorOne 

Multiplies the source color by one.

BlendSrcColorFactorSrcColor 

Multiplies the source color component-wise by source color.

BlendSrcColorFactorOneMinusSrcColor 

Multiplies the source color component-wise by one minus source color.

BlendSrcColorFactorDstColor 

Multiplies the source color component-wise by destination color.

BlendSrcColorFactorOneMinusDstColor 

Multiplies the source color component-wise by one minus destination color.

BlendSrcColorFactorSrcAlpha 

Multiplies the source color by source alpha.

BlendSrcColorFactorOneMinusSrcAlpha 

Multiplies the source color by one minus source alpha.

BlendSrcColorFactorDstAlpha 

Multiplies the source color by destination alpha.

BlendSrcColorFactorOneMinusDstAlpha 

Multiplies the source color by one minus destination alpha.

BlendSrcColorFactorConstantColor 

Multiplies the source color component-wise by constant color.

This requires a constant blend color to be specified.

BlendSrcColorFactorOneMinusConstantColor 

Multiplies the source color component-wise by one minus constant color.

This requires a constant blend color to be specified.

BlendSrcColorFactorConstantAlpha 

Multiplies the source color by constant alpha.

This requires a constant blend color to be specified.

BlendSrcColorFactorOneMinusConstantAlpha 

Multiplies the source color by one minus constant alpha.

This requires a constant blend color to be specified.

BlendSrcColorFactorSrcAlphaSaturate 

Multiplies the source color by smaller of source alpha and one minus destination alpha.

BlendSrcColorFactorMask 

Source color factor mask.

◆ BlendSrcAlphaFactor

Blend factor for source alpha.

Since
Kanzi 3.9.1
Enumerator
BlendSrcAlphaFactorZero 

Multiplies the source alpha by zero.

BlendSrcAlphaFactorOne 

Multiplies the source alpha by one.

BlendSrcAlphaFactorSrcAlpha 

Multiplies the source alpha by source alpha.

BlendSrcAlphaFactorOneMinusSrcAlpha 

Multiplies the source alpha by one minus source alpha.

BlendSrcAlphaFactorDstAlpha 

Multiplies the source alpha by destination alpha.

BlendSrcAlphaFactorOneMinusDstAlpha 

Multiplies the source alpha by one minus destination alpha.

BlendSrcAlphaFactorConstantAlpha 

Multiplies the source alpha by constant alpha.

This requires a constant blend color to be specified.

BlendSrcAlphaFactorOneMinusConstantAlpha 

Multiplies the source alpha by one minus constant alpha.

This requires a constant blend color to be specified.

BlendSrcAlphaFactorMask 

Source alpha factor mask.

◆ BlendDstColorFactor

Blend factor for destination color.

Since
Kanzi 3.9.1
Enumerator
BlendDstColorFactorZero 

Multiplies the destination color by zero.

BlendDstColorFactorOne 

Multiplies the destination color by one.

BlendDstColorFactorSrcColor 

Multiplies the destination color component-wise by source color.

BlendDstColorFactorOneMinusSrcColor 

Multiplies the destination color component-wise by one minus source color.

BlendDstColorFactorDstColor 

Multiplies the destination color component-wise by destination color.

BlendDstColorFactorOneMinusDstColor 

Multiplies the destination color component-wise by one minus destination color.

BlendDstColorFactorSrcAlpha 

Multiplies the destination color by source alpha.

BlendDstColorFactorOneMinusSrcAlpha 

Multiplies the destination color by one minus source alpha.

BlendDstColorFactorDstAlpha 

Multiplies the destination color by destination alpha.

BlendDstColorFactorOneMinusDstAlpha 

Multiplies the destination color by one minus destination alpha.

BlendDstColorFactorConstantColor 

Multiplies the destination color component-wise by constant color.

This requires a constant blend color to be specified.

BlendDstColorFactorOneMinusConstantColor 

Multiplies the destination color component-wise by one minus constant color.

This requires a constant blend color to be specified.

BlendDstColorFactorConstantAlpha 

Multiplies the destination color by constant alpha.

This requires a constant blend color to be specified.

BlendDstColorFactorOneMinusConstantAlpha 

Multiplies the destination color by one minus constant alpha.

This requires a constant blend color to be specified.

BlendDstColorFactorSrcAlphaSaturate 

Multiplies the destination color by smaller of source alpha and one minus destination alpha.

BlendDstColorFactorMask 

Destination color factor mask.

◆ BlendDstAlphaFactor

Blend factor for destination alpha.

Since
Kanzi 3.9.1
Enumerator
BlendDstAlphaFactorZero 

Multiplies the destination alpha by zero.

BlendDstAlphaFactorOne 

Multiplies the destination alpha by one.

BlendDstAlphaFactorSrcAlpha 

Multiplies the destination alpha by source alpha.

BlendDstAlphaFactorOneMinusSrcAlpha 

Multiplies the destination alpha by one minus source alpha.

BlendDstAlphaFactorDstAlpha 

Multiplies the destination alpha by destination alpha.

BlendDstAlphaFactorOneMinusDstAlpha 

Multiplies the destination alpha by one minus destination alpha.

BlendDstAlphaFactorConstantAlpha 

Multiplies the destination alpha by constant alpha.

This requires a constant blend color to be specified.

BlendDstAlphaFactorOneMinusConstantAlpha 

Multiplies the destination alpha by one minus constant alpha.

This requires a constant blend color to be specified.

BlendDstAlphaFactorMask 

Source alpha factor mask.

◆ BlendColorEquation

Blend equation for color.

Since
Kanzi 3.9.1
Enumerator
BlendColorEquationNone 

Disables blending.

BlendColorEquationAdd 

Adds the source color and destination color.

BlendColorEquationSubtract 

Subtracts the destination color from source color.

BlendColorEquationReverseSubtract 

Subtracts the source color from destination color.

BlendColorEquationMin 

Returns the component-wise minimum of the source color and destination color.

BlendColorEquationMax 

Returns the component-wise maximum of the source color and destination color.

BlendColorEquationComponentMask 

Color equation mask.

◆ BlendAlphaEquation

Blend equation for alpha.

Since
Kanzi 3.9.1
Enumerator
BlendAlphaEquationNone 

Disables blending.

BlendAlphaEquationAdd 

Adds the source alpha and destination alpha.

BlendAlphaEquationSubtract 

Subtracts the destination alpha from source alpha.

BlendAlphaEquationReverseSubtract 

Subtracts the source alpha from destination alpha.

BlendAlphaEquationMin 

Returns the smaller of the source alpha and destination alpha.

BlendAlphaEquationMax 

Returns the larger of the source alpha and destination alpha.

BlendAlphaEquationComponentMask 

Alpha equation mask.

◆ BlendAdvancedEquation

Specifies the blend equations for the advanced blend modes.

Since
Kanzi 3.9.6
Enumerator
BlendAdvancedEquationNone 

None.

BlendAdvancedEquationComponentMask 

Advanced equation mask.

◆ GraphicsClearTarget

Clear target options for renderer.

Enumerator
GraphicsClearTargetColor0 

Clear target color buffer 0.

GraphicsClearTargetColor1 

Clear target color buffer 1.

GraphicsClearTargetColor2 

Clear target color buffer 2.

GraphicsClearTargetColor3 

Clear target color buffer 3.

Clear target depth.

GraphicsClearTargetDepth 
GraphicsClearTargetStencil 

Clear target stencil.

GraphicsClearTargetCoverage 

Clear target coverage buffer.

◆ IndexBufferType

List of available types available for index buffers.

Enumerator
IndexBufferTypeUInt16 

Type UInt16 (Unsigned Short)

IndexBufferTypeUInt32 

Type UInt32 (Unsigned Int)

◆ GraphicsCullMode

List of available cull modes.

Enumerator
GraphicsCullModeNone 

No culling.

GraphicsCullModeBack 

Backface culling.

GraphicsCullModeFront 

Frontface culling.

◆ GraphicsScalar

List of active renderer scalars for fixed functionality.

Enumerator
GraphicsScalarClearDepth 

Clear depth value.

GraphicsScalarCameraNearPlane 

Camera near plane distance.

GraphicsScalarCameraFarPlane 

Camera far plane distance.

GraphicsScalarCount 

Maximum amount of scalars.

◆ GraphicsCompareFunction

Renderer stencil modes.

Enumerator
GraphicsCompareFunctionNever 

Always fails.

GraphicsCompareFunctionAlways 

Always passes.

GraphicsCompareFunctionLess 

(Ref & mask) < (stencil & mask).

GraphicsCompareFunctionLessOrEqual 

(Ref & mask) <= (stencil & mask).

GraphicsCompareFunctionGreater 

(Ref & mask) > (stencil & mask).

GraphicsCompareFunctionGreaterOrEqual 

(Ref & mask) >= (stencil & mask).

GraphicsCompareFunctionEqual 

(Ref & mask) = (stencil & mask).

GraphicsCompareFunctionNotEqual 

(Ref & mask) != (stencil & mask).

GraphicsCompareFunctionDisabled 

Compare/test is disabled.

◆ GraphicsStencilOperation

Renderer stencil operations.

Enumerator
GraphicsStencilOperationKeep 

Keeps the current stencil buffer value.

GraphicsStencilOperationZero 

Sets stencil buffer value to zero.

GraphicsStencilOperationReplace 

Set stencil buffer value to reference value, specified by StencilFunction.

GraphicsStencilOperationIncrement 

Increases current stencil buffer value.

GraphicsStencilOperationIncrementWrap 

Increases stencil buffer value, wraps to zero when reaching maximum.

GraphicsStencilOperationDecrement 

Decreases current stencil buffer value.

GraphicsStencilOperationDecrementWrap 

Decreases stencil buffer value, wraps to maximum - 1 when below 0.

GraphicsStencilOperationInvert 

Inverts current stencil buffer value.

◆ GraphicsColorWriteMode

List of color write modes.

Enumerator
GraphicsColorWriteModeNone 

No color write.

GraphicsColorWriteModeRGB 

Color write for RGB channels.

GraphicsColorWriteModeRGBA 

Color write for RGBA channels.

GraphicsColorWriteModeR 

Color write for red channel.

GraphicsColorWriteModeG 

Color write for green channel.

GraphicsColorWriteModeB 

Color write for blue channel.

GraphicsColorWriteModeGB 

Color write for cyan (green+blue).

GraphicsColorWriteModeA 

Color write for alpha channel.

◆ GraphicsPrimitiveType

Enumeration for index buffer primitive type.

Since
Kanzi 3.9.6 tessellation patches.
Enumerator
GraphicsPrimitiveTypeInvalid 

Invalid primitive type.

GraphicsPrimitiveTypePoints 

Point primitive type.

GraphicsPrimitiveTypeLines 

Line primitive type.

GraphicsPrimitiveTypeLineLoop 

Line loop primitive type.

GraphicsPrimitiveTypeLineStrip 

Line strip primitive type.

GraphicsPrimitiveTypeTriangles 

Triangle primitive type.

GraphicsPrimitiveTypeTriangleStrip 

Triangle strip primitive type.

GraphicsPrimitiveTypeTriangleFan 

Triangle fan primitive type.

GraphicsPrimitiveTypePatches 

Tessellation patches primitive type.

◆ GraphicsFillMode

Enumerator
GraphicsFillModeSolid 

Solid fill mode.

GraphicsFillModeWireframe 

Wireframe fill mode.

◆ ShaderType

List of shader types.

Since
Kanzi 3.9.6 geometry and tessellation shaders.
Enumerator
ShaderTypeInvalid 

Not a valid shader.

ShaderTypeVertex 

Vertex shader.

ShaderTypeFragment 

Fragment shader.

ShaderTypeGeometry 

Geometry shader.

ShaderTypeTessellationControl 

Tessellation control shader.

ShaderTypeTessellationEvaluation 

Tessellation evaluation shader.

◆ GraphicsFormatFeature

How GraphicsFormat is used.

Enumerator
GraphicsFormatFeatureRenderbuffer 

Can be used as renderbuffer (0x1)

GraphicsFormatFeatureSampledImage 

Can be sampled from (0x2)

GraphicsFormatFeatureSampledImageFilterLinear 

Can be used with a sampler that uses linear filtering (0x4)

GraphicsFormatFeatureColorAttachment 

Can be used as a framebuffer color attachment and as an input attachment (0x8)

GraphicsFormatFeatureColorAttachmentBlend 

Can be used as a framebuffer color attachment that supports blending and as an input attachment (0x10)

GraphicsFormatFeatureDepthStencilAttachment 

Can be used as a framebuffer depth/stencil attachment and as an input attachment (0x20)

GraphicsFormatFeatureBlitSource 

Can be used as source image for blit operation (0x40)

GraphicsFormatFeatureBlitDestination 

Can be used as destination image for blit operation (0x80)

GraphicsFormatFeatureVertexBuffer 
GraphicsFormatFeatureUniformTexelBuffer 
GraphicsFormatFeatureStorageTexelBuffer 
GraphicsFormatFeatureStorageTexelBufferAtomic 
GraphicsFormatFeatureStorageImage 

Can be used as storage image.

GraphicsFormatFeatureStorageImageAtomic 

can be used as storage image that supports atomic operations

GraphicsFormatFeatureRenderbufferMask 

Combined mask for renderbuffer features.

GraphicsFormatFeatureTextureMask 

Combined mask for texture features.

◆ FramebufferAttachmentPoint

Enumerator
FramebufferAttachmentPointColor0 

Color buffer 0 framebuffer attachment point (OpenGL ES 2 compatible)

FramebufferAttachmentPointColor1 

Color buffer 1 framebuffer attachment point (Requires OpenGL ES 3)

FramebufferAttachmentPointColor2 

Color buffer 2 framebuffer attachment point (Requires OpenGL ES 3)

FramebufferAttachmentPointColor3 

Color buffer 3 framebuffer attachment point (Requires OpenGL ES 3)

FramebufferAttachmentPointDepthStencil 

Depth and stencil framebuffer attachment point.

FramebufferAttachmentPointCount 

Number of attachment points in Framebuffer.

◆ FramebufferTarget

Framebuffer target selects draw or read framebuffer, or both.

Enumerator
FramebufferTargetReadAndDraw 

Both read and draw framebuffers.

FramebufferTargetRead 

Read framebuffe.

FramebufferTargetDraw 

Draw framebuffer.

◆ Multisample

Multisample support code path in Renderer.

Enumerator
MultisampleNone 

No multisample support.

MultisampleARB 

Multisample using desktop OpenGL.

MultisampleES2NVidia 

Multisample using NVidia extensions for OpenGL ES 2.

MultisampleES3 

Multisample using OpenGL ES 3 BlitFramebuffer.

MultisampleES2Ext 

Multisample using OpenGL ES 2 multivendor extension.

MultisampleES2Img 

Multisample using Imagination Technologies extension for OpenGL ES 2.

◆ MultisampleCount

Specifies the available numbers of samples for multisample anti-aliasing (MSAA).

Enumerator
NoMSAA 

Single sample. Disables MSAA.

MSAAx2 

MSAA with 2 samples.

MSAAx4 

MSAA with 4 samples.

MSAAx8 

MSAA with 8 samples.

MSAAx16 

MSAA with 16 samples.

MSAAx32 

MSAA with 32 samples.

◆ ProgramBinary

Program binary support code path in Renderer.

Enumerator
ProgramBinaryNone 

No program binary support.

ProgramBinaryARB 

Program binary using desktop OpenGL.

ProgramBinaryES3 

Program binary using OpenGL ES 3.

ProgramBinaryES2Ext 

Program binary using OpenGL ES 2 multivendor extension.

◆ HalfFloatTexture

Half float texture support code path in Renderer.

Enumerator
HalfFloatTextureNone 

No support for half float textures.

HalfFloatTextureARB 

Half float textures supported using desktop OpenGL.

HalfFloatTextureES3 

Half float textures supported using OpenGL ES 3.

HalfFloatTextureES2Ext 

Half float textures supported using OpenGL ES 2 multivendor extension.

◆ HalfFloatVertexAttribute

Half float vertex attribute code path in Renderer.

Enumerator
HalfFloatVertexAttributeNone 

Half-float vertex attribute not supported.

HalfFloatVertexAttributeDefault 

Half-float vertex attribute default path.

HalfFloatVertexAttributeOES 

Half-float vertex attribute OES path.

◆ FloatTexture

Float texture support code path in Renderer.

Enumerator
FloatTextureNone 

No support for float textures.

FloatTextureARB 

Float textures supported using desktop OpenGL.

FloatTextureES3 

Float textures supported using OpenGL ES 3.

FloatTextureES2Ext 

Float textures supported using OpenGL ES 2 multivendor extension.

◆ TexStorage

Texture Storage support code path in Renderer.

Enumerator
TexStorageNone 
TexStorageMultisampleARB 
TexStorageARB 
TexStorageES2Ext 
TexStorageES3 
TexStorageES31 
TexStorageES32 

◆ DrawBuffers

Draw multiple buffers support code path in Renderer.

Enumerator
DrawBuffersNone 

No Draw buffers support.

DrawBuffersDefault 

Draw buffers using desktop OpenGL >= 3 or OpenGL ES >= 3.

DrawBuffersExt 

Draw buffers using multivendor extension.

DrawBuffersNV 

Draw buffers using NVidia extension.

◆ InvalidateFramebuffer

Framebuffer invalidation support code path in Renderer.

Enumerator
InvalidateFramebufferNone 

No support for framebuffer invalidation.

InvalidateFramebufferARB 

Framebuffer invalidation supported using desktop OpenGL.

InvalidateFramebufferES3 

Framebuffer invalidation supported using OpenGL ES 3.

InvalidateFramebufferES2Ext 

Framebuffer invalidation supported using OpenGL ES 2 multivendor extension.

◆ RendererState

Renderer state enumerations.

Enumerator
RendererStateDepthTest 

Renderer state for depth testing.

RendererStateCullFace 

Renderer state for cull face.

RendererStateBlend 

Renderer state for blending.

RendererStateDepthWrite 

Renderer state for depth write.

RendererStateStencilTest 

Renderer state for stencil test.

RendererStateStencilWrite 

Renderer state for stencil write.

RendererStateMultisample 

Renderer state for multi-sampling.

RendererStateScissorTest 

Renderer state for scissor test.

RendererStateCoverageWrite 

Renderer state for coverage write.

RendererStateCount 

Maximum count of renderer states.

◆ FixedMatrix

List of active matrices renderer keeps track of.

Enumerator
FixedMatrixProjection 

Projection matrix.

FixedMatrixCamera 

Camera matrix.

FixedMatrixWorld 

Current world matrix.

FixedMatrixCameraWorld 

Current camera * world matrix.

FixedMatrixProjectionCameraWorld 

Current projection * camera * world matrix.

FixedMatrixCount 

Maximum amount of matrices.

◆ RendererSupport

List of optionally supported renderer features.

Since
3.9.6 Instancing, geometry and tessellation shaders, ES3.x compatibility modes.
Enumerator
RendererSupportHalfFloatTextureFormatLinear 
RendererSupportHalfFloatColorAttachment 
RendererSupportNPOTTextureFilter 
RendererSupportRenderToMipmapLevels 
RendererSupportDepth16Renderbuffer 
RendererSupportDepth16Texture 
RendererSupportDepth24Renderbuffer 
RendererSupportDepth24Texture 
RendererSupportDepth24Stencil8Renderbuffer 
RendererSupportDepth24Stencil8Texture 
RendererSupportDepth32Renderbuffer 
RendererSupportDepth32fRenderbuffer 
RendererSupportDepth32fTexture 
RendererSupportStencil8Renderbuffer 
RendererSupportStencil8Texture 
RendererSupportExternalTexture 
RendererSupportTexture2DArray 
RendererSupportTexture3D 
RendererSupportTextureCubeMapArray 
RendererSupportTextureMultisample2D 
RendererSupportTextureMultisample2DArray 
RendererSupportTextureFilterAnisotropic 
RendererSupportTextureSwizzle 
RendererSupportTextureSwizzleComponent 
RendererSupportTextureMaximumLevel 
RendererSupportSeamlessCubeMap 
RendererSupportRGB8Renderbuffer 
RendererSupportRG8Formats 
RendererSupportRGFormats 
RendererSupportIntegerFormats 
RendererSupportRGB8Texture 
RendererSupportRGBA8Renderbuffer 
RendererSupportRGBA8Texture 
RendererSupportDiscardFramebuffer 
RendererSupportInvalidateFramebuffer 
RendererSupportImplementationColorRead 
RendererSupportKHRDebug 
RendererSupportShaderBinary 
RendererSupportSRGB 
RendererSupportSRGB8Texture 
RendererSupportSRGB8TexStorage 
RendererSupportETC1NPOT 
RendererSupport10_10_10_2VertexAttribute 
RendererSupportDepthComparison 
RendererSupport32BitIndexBuffer 
RendererSupportMapBufferRange 
RendererSupportSNORMFormats 
RendererSupportFloatTextureFormatLinear 
RendererSupportFloatColorAttachment 
SupportTextureNorm16Formats 
RendererSupportTextureMirrorClampToEdge 
RendererSupportUnpackRowLength 
RendererSupportClearBuffer 
RendererSupportKHRBlendEquationAdvanced 
RendererSupportInstancing 
RendererSupportGeometryShader 
RendererSupportTessellationShader 
RendererSupportES30 
RendererSupportES31 
RendererSupportES32 
RendererSupportCount 

◆ TextureType

Texture type.

Enumerator
TextureTypeTwoDimensional 

Two dimensional texture.

TextureTypeTwoDimensionalArray 

Reserved for future use.

Do not use. Two dimensional array texture.

TextureTypeTwoDimensionalMultisample 

Reserved for future use.

Do not use. Two dimensional multisample texture.

TextureTypeTwoDimensionalMultisampleArray 

Reserved for future use.

Do not use. Two dimensional multisample array texture.

TextureTypeThreeDimensional 

Reserved for future use.

Do not use. Three dimensionla texture.

TextureTypeCubeMap 

Cubemap texture.

TextureTypeCubeMapArray 

Reserved for future use.

Do not use. Cubemap array texture.

TextureTypeExternal 

External texture.

Note
External textures are specific to OpenGL ES and EGL.
TextureTypeCount 

Number of valid texture targets.

TextureTypeInvalid 

Invalid texture target.

◆ SphereTessellationType

Specifies the available sphere tessellation types.

Enumerator
SphereTypeUvSphere 

UV Sphere consists of fans of triangles at the poles and quad faces elsewhere.

SphereTypeIcosphere 

Icosphere is a subdivided icosahedron that consists of triangles.

SphereTypeQuadSphere 

Quad sphere is a subdivided box consisting of quads projected to a sphere.

◆ RenderTargetMode

RenderTarget mode for Texture.

Rendering to a Texture may require extra resources (such as framebuffer when using OpenGL or OpenGL ES). RenderTargetMode specifies who manages these resources.

Enumerator
RenderTargetModeNone 

When texture has rendertarget mode RenderTargetModeNone, that texture cannot be rendered to.

You must not set such texture as render target for 2D nodes. You should not set such texture as render target for renderpasses.

RenderTargetModeInternal 

RenderTargetModeInternal allows texture to be rendered to without externally managed resources.

You can set such texture as render target for 2D nodes.
You should not set such texture as render target for renderpasses.

\note Implementation details:
      When you create texture with renderTargetMode set to RenderTargetModeInternal, texture
      will internally maintain necessary resources that are required to perform rendering to
      the texture. When such texture is created, the texture will also maintain a framebuffer
      and optional depth stencil renderbuffer.

\note Use Texture::getNativeFramebufferHandle() to get handle to the framebuffer object in the texture. 
RenderTargetModeExternal 

RenderTargetModeExternal allows texture to be rendered to with externally managed resources.

You can set texture as render target for renderpasses.
You must not set texture as render target for 2D nodes.

When you create texture with renderTargetMode set to RenderTargetModeExternal, an external
entity such as renderpass is responsible for creating necessary resources that are
required to perform rendering to the texture. 

◆ KzuViewportCoordinateType

Enumeration for viewport coordinate unit type (exact pixel coordinates / percentages from window)

Enumerator
KZU_VIEWPORT_COORDINATE_ABSOLUTE 

Absolute viewport coordinates, i.e. pixel values.

KZU_VIEWPORT_COORDINATE_RELATIVE 

Relative viewport coordinates, i.e. percentages of render target width & height.

◆ FocusScopeType

Specifies focus scope types.

Since
Kanzi 3.9.2 detached from FocusManager
Enumerator
NoScope 

Removes previously set focus scope data from a Node or focus scope info. Kanzi uses this value internally.

Group 

Focus group groups focusable nodes. You can move the focus to a focus group and out of the focus group.

Fence 

Focus fence keeps the focus navigation inside the scope and does not allow the focus navigation to enter or leave that scope.

Modal 

Modal overlay blocks the key and touch input that originates from outside its boundaries and keeps the focus navigation within the overlay boundaries, just like a focus fence.

Every Kanzi application has at least one modal overlay: the Screen node.

When input occurs outside the boundaries of a modal focus scope, Kanzi dispatches the FocusManager::InputOutsideOverlayMessage to the focus scope node.

AutoClosingModal 

Auto-closing modal overlay is similar to modal overlay, except that when the overlay is an Activity in a Parallel Activity Host, the Parallel Activity Host deactivates that Activity when input originates from outside the boundaries of that Activity.

When input occurs outside the boundaries of an auto-closing modal focus scope, Kanzi dispatches the FocusManager::InputOutsideOverlayMessage to the focus scope node, and suppresses that input. A Parallel Activity Host automatically handles the InputOutsideOverlayMessage message sent by an Activity which is an auto-closing modal overlay.

Popup 

Sets a node to be a popup overlay focus scope.

Deprecated
In Kanzi 3.9.2. Use FocusScopeType::AutoClosingModal instead.
Modeless 

Modeless overlay propagates the key and touch input that originates from outside its boundaries, but keeps the focus navigation within the focus scope boundaries, just like a modal overlay.

When input occurs outside the boundaries of a modeless focus scope, Kanzi dispatches the FocusManager::InputOutsideOverlayMessage to the focus scope node.

AutoClosingModeless 

Auto-closing modeless overlay is similar to modeless overlay, except that when the overlay is an Activity in a Parallel Activity Host, the Parallel Activity Host deactivates that Activity when input originates from outside the boundaries of that Activity.

When input occurs outside the boundaries of an auto-closing modeless focus scope, Kanzi dispatches the FocusManager::InputOutsideOverlayMessage to the focus scope node. A Parallel Activity Host automatically handles the InputOutsideOverlayMessage message sent by an Activity which is an auto-closing modeless overlay.

◆ FocusState

Specifies the focus states of a node.

Since
Kanzi 3.9.2
Enumerator
NoFocus 

Not focused.

This is the default value. For a focus scope node this value means that none of the nodes in that scope is the focus node of the overlay to which the scope belongs.

LogicalFocus 

The node is the logical focus node.

The node had the key focus before the overlay, to which the node belongs, lost the focus. When the overlay regains the focus, the logical focus node of that overlay becomes the key focus node. For a focus scope node this value means that one of the nodes in that scope is the logical focus node of an overlay.

KeyboardFocus 

The node is the keyboard focus node of the application.

Kanzi delivers keyboard input to the keyboard focus node. For a focus scope node this value means that one of the nodes in that scope is the keyboard focus node of the application.

Deprecated
In Kanzi 3.9.6. Use FocusState::KeyFocus instead.
KeyFocus 

The node is the key focus node of the application.

Kanzi delivers key input to the key focus node. For a focus scope node this value means that one of the nodes in that scope is the key focus node of the application.

Since
Kanzi 3.9.6.

◆ FocusReason

Specifies the reason the node is focused.

Since
Kanzi 3.9.2 detached from FocusManager
Enumerator
Force 

The focus is forced on the node.

FocusChainNavigation 

The focus moves as the result of focus chain navigation.

Hidden 

The focus moves because the Node::VisibleProperty of the node that has the focus is set to false.

Kanzi uses this value only in post-focus messages.

ForceToRootNode 

The focus is forced on the focus scope root node.

Since
Kanzi 3.9.7
Other 

The focus moves by means other than FocusReason::Force, FocusReason::FocusChainNavigation or FocusReason::Hidden.

Deprecated
In Kanzi 3.9.2

◆ FocusChainDirection

Specifies the directions of focus move.

Since
Kanzi 3.9.2 detached from FocusManager
Enumerator
Previous 

Moves the focus to the previous focusable node.

Next 

Moves the focus to the next focusable node.

◆ FocusFallback

Fallback behavior to follow if node fails to gain focus.

Since
Kanzi 3.9.3
Enumerator
None 

Does not try to set focus to any node.

Parent 

Moves up the node tree, trying to set focus to the nearest ancestor node in the overlay focus scope.

Overlay 

Tries to set focus to the root node of the overlay focus scope.

The focus scope node forwards the focus to a focusable child node.

◆ FocusOnPress

Focus behavior on node press.

Since
Kanzi 3.9.4
Enumerator
None 

Does nothing.

Node 

Tries to set focus to the node that the user pressed and if that fails, does nothing.

NodeOrAncestor 

Tries to set focus to the node that the user pressed and if that fails, sets focus to the nearest focusable ancestor of that node.

NodeOrOverlay 

Tries to set focus to the node that the user pressed and if that fails, sets focus to the overlay scope that contains the node.

◆ CapsLockState

The required Caps Lock state for a key gesture.

Since
Kanzi 3.9.0
Enumerator
Ignore 

The key gesture does not require a specific Caps Lock state.

On 

The key gesture requires Caps Lock to be on.

Off 

The key gesture requires Caps Lock to be off.

◆ KeyMatchResult

Key matching result values.

Since
Kanzi 3.9.0
Enumerator
NoMatch 

Value returned when the key event modifier or key value does not match with the key gesture.

Match 

Value returned when the key event modifier or key value matches with the key gesture.

PartialMatch 

Value returned when only a part of the key event modifier or key value matches with the key gesture.

◆ NavigationDirection

Specifies the navigation directions supported by the manipulator.

Since
Kanzi 3.9.0 - a standalone enum
Enumerator
Up 

Identifies the navigation direction Up.

Down 

Identifies the navigation direction Down.

Left 

Identifies the navigation direction Left.

Right 

Identifies the navigation direction Right.

Home 

Identifies the navigation direction Home.

End 

Identifies the navigation direction End.

PageUp 

Identifies the navigation direction PageUp.

PageDown 

Identifies the navigation direction PageDown.

◆ TextKeyNavigationDirection

Key navigation directions.

Since
Kanzi 3.9.0
Enumerator
LeftToRight 

Specifies left-to-right key navigation where:

  • Right arrow key moves cursor or selection end point forward in the logical order of the characters.
  • Left arrow key moves cursor or selection end point backward in the logical order of the characters.
RightToLeft 

Specifies right-to-left key navigation where:

  • Left arrow key moves cursor or selection end point forward in the logical order of the characters.
  • Right arrow key moves cursor or selection end point backward in the logical order of the characters.

◆ InputType

The input type used by the input method listener.

Since
Kanzi 3.9.0
Enumerator
Default 

The input is the default of the input method.

Numeric 

The input is numeric.

Email 

The input requires a layout with characters used in email addresses.

URL 

The input requires a layout with characters used in URLs.

◆ InputMethodAction

Specifies the available input method actions.

Enumerator
Default 

The label of the user action button is the default for the input method of the Operating System.

Go 

The label of the user action button is Go.

Next 

The label of the user action button is Next.

Search 

The label of the user action button is Search.

Send 

The label of the user action button is Send.

Done 

The label of the user action button is Done.

◆ MainLoopState

Enumeration for application states.

Enumerator
Running 

The application is running normally.

Paused 

The application is paused. The application lost the graphics context.

Quitting 

The application is in the process of quitting without errors.

◆ EGLContextClientVersion

EGL context client version.

Since
Kanzi 3.9.7
Enumerator
Version1 

EGL context client version 1.

Version2 

EGL context client version 2.

Version3 

EGL context client version 3.

◆ EGLContextClientSelection

Represents your selection of the EGL context client version.

Since
Kanzi 3.9.10
Enumerator
Version1 

EGL context client version 1.

Version2 

EGL context client version 2.

Version3 

EGL context client version 3.

Unspecified 

EGL context client version is explicitly set as unspecified. Provides no value to the EGL attrib_list.

Automatic 

Tries to automatically use the highest available EGLContextClientVersion supported by Kanzi.

◆ EGLIMGContextPriority

EGL IMG context priorities.

Since
Kanzi 3.9.8
Enumerator
High 

EGL IMG context high priority.

Medium 

EGL IMG context medium priority.

Low 

EGL IMG context low priority.

◆ EGLSurfaceType

EGL surface types.

Since
Kanzi 3.9.7
Enumerator
Window 

EGL window surface type.

Pbuffer 

EGL pixel buffer surface type.

Pixmap 

EGL pixmap surface type.

◆ KzbProgramType

Internal enum that is used to describe the data in the kzb file.

Enumerator
KzbProgramTypeSeparate 

The shader binaries are stored separately.

KzbProgramTypeCombined 

All shaders combined into one binary.

◆ SurfaceClientAPI

Client graphics API for a surface.

Enumerator
Unspecified 

Surface rendering API is unspecified.

OpenGLES 

Surface is target for OpenGLES rendering.

OpenVG 

Surface is target for OpenVG rendering.

OpenGL 

Surface is target for OpenGL rendering.

◆ GraphicsContextAPI

Graphics context API for a surface.

Enumerator
Unspecified 

Graphics context API is unspecified.

WGL 

WGL graphics context API.

EGL 

EGL graphics context API.

GLX 

GLX graphics context API.

◆ SwapBehavior

Enumerator
Unspecified 

Buffer contents become unspecified on swap.

If whole screen is not redrawn each frame, there may be unexpected content.

Copy 

Buffer contents are preserved on swap.

Exchange 

Older buffer is recycled on swap.

◆ QnxChannelIDFlags

QNX channel ID flags.

Enumerator
Default 
Priority 
Unblock 
ThreadDeath 
Disconnect 
NetMsg 
SenderLen 
CoIdDisconnect 
ReplyLen 
AsyncNonblock 
Async 
Global 
Private 
MsgPausing 
UnblockTimer 

◆ WindowOrientation

List of window orientations.

Enumerator
LandscapeOrientation 

Landscape orientation.

PortraitOrientation 

Portrait orientation.

◆ WindowStyle

Styles for a window.

Since
Kanzi 3.9.7
Enumerator
Fixed 

A window that cannot be resized.

Resizable 

A window that can be resized.

Fullscreen 

A window that occupies the entire screen.

Borderless 

A window without borders or other decorations.

StudioPreview 

A docked window with external message handling. Used only by Kanzi Studio.

Default 

The system selects the appropriate window style for the platform.

◆ EchoMode

Echo modes that specify how to format the display text in a TextEditBuffer.

Enumerator
Normal 

The characters are visible.

NoEcho 

The characters are not visible.

Password 

Kanzi masks each character with the character set using TextEditBuffer::setPasswordMaskingCharacter().

◆ MmapMode

Specifies the available methods for memory mapping files.

Enumerator
Default 

Use system default.

Lazy 

Use lazy mapping whenever possible.

Eager 

Use eager mapping whenever possible.

◆ LogLevel

The log levels.

The LogLevel is used internally to convert integer log level value to enumeration type.

Enumerator
LogLevelError 

The error log level. See KZ_LOG_LEVEL_ERROR.

LogLevelWarning 

The warning log level. See KZ_LOG_LEVEL_WARNING.

LogLevelInfo 

The info log level. See KZ_LOG_LEVEL_INFO.

LogLevelTrace 

The trace log level. See KZ_LOG_LEVEL_TRACE.

◆ Slog2VerbosityLevel

Slogger2 verbosity levels.

Enumerator
Slog2Shutdown 
Slog2Critical 
Slog2Error 
Slog2Warning 
Slog2Notice 
Slog2Info 
Slog2Debug1 
Slog2Debug2 

◆ MessageRouting

Message routing modes.

Enumerator
MessageRoutingTunneling 

Identifies the tunneling phase, during which a message travels down the node tree from the first child node of the Screen node (the root node) to the node where the message originated.

MessageRoutingBubbling 

Identifies the bubbling phase, during which a message travels up the node tree from the node where the message originated to the first child node of the Screen node (the root node).

MessageRoutingTunnelingBubbling 

Identifies both, the tunneling and the bubbling phase.

◆ PropertyDataType

Enumeration of data types that can be stored as properties.

Enumerator
PropertyDataTypeFloat 

Float data.

PropertyDataTypeInt 

Integer data.

PropertyDataTypeBool 

Boolean data.

PropertyDataTypeColor 

ColorRGBA data.

PropertyDataTypeVector2 

Vector2 data.

PropertyDataTypeVector3 

Vector3 data.

PropertyDataTypeVector4 

Vector4 data.

PropertyDataTypeMatrix3x3 

Matrix3x3 data.

PropertyDataTypeMatrix4x4 

Matrix4x4 data.

PropertyDataTypeString 

String data.

PropertyDataTypePointer 

Pointer data.

PropertyDataTypeResource 

Resource data.

PropertyDataTypeSRT2D 

SRTValue2D data.

PropertyDataTypeSRT3D 

SRTValue3D data.

PropertyDataTypeRange 

Range data.

◆ PropertyField

Property field.

Enumerator
PropertyFieldWhole 

Whole property value.

PropertyFieldTranslationX 

Translation X component, presented as float.

PropertyFieldTranslationY 

Translation Y component, presented as float.

PropertyFieldTranslationZ 

Translation Z component, presented as float.

PropertyFieldScaleX 

Scale X component, presented as float.

PropertyFieldScaleY 

Scale Y component, presented as float.

PropertyFieldScaleZ 

Scale Z component, presented as float.

PropertyFieldRotationX 

Rotation X component, presented as float.

PropertyFieldRotationY 

Rotation Y component, presented as float.

PropertyFieldRotationZ 

Rotation Z component, presented as float.

PropertyFieldColorR 

Color R field, presented as float.

PropertyFieldColorG 

Color G field, presented as float.

PropertyFieldColorB 

Color B field, presented as float.

PropertyFieldColorA 

Color A field, presented as float.

PropertyFieldVectorX 

Vector X field, presented as float.

PropertyFieldVectorY 

Vector Y field, presented as float.

PropertyFieldVectorZ 

Vector Z field, presented as float.

PropertyFieldVectorW 

Vector W field, presented as float.

PropertyFieldRotation 

Rotation component of property of SRTValue3D type, presented as Quaternion.

Function Documentation

◆ animationInterpolate() [1/11]

template<typename T >
T kanzi::animationInterpolate ( const T & from,
const T & to,
float phase )

◆ animationInterpolate() [2/11]

int kanzi::animationInterpolate ( int from,
int to,
float phase )
inline

◆ animationInterpolate() [3/11]

bool kanzi::animationInterpolate ( bool from,
bool to,
float phase )
inline

◆ animationInterpolate() [4/11]

string kanzi::animationInterpolate ( const string & from,
const string & to,
float phase )
inline

◆ animationInterpolate() [5/11]

ResourceID kanzi::animationInterpolate ( const ResourceID & from,
const ResourceID & to,
float phase )
inline

◆ animationInterpolate() [6/11]

const ResourceSharedPtr & kanzi::animationInterpolate ( const ResourceSharedPtr & from,
const ResourceSharedPtr & to,
float phase )
inline

◆ animationInterpolate() [7/11]

Quaternion kanzi::animationInterpolate ( const Quaternion & from,
const Quaternion & to,
float phase )
inline

◆ animationInterpolate() [8/11]

QuaternionLongerPath kanzi::animationInterpolate ( const QuaternionLongerPath & from,
const QuaternionLongerPath & to,
float phase )
inline

◆ animationInterpolate() [9/11]

SRTValue3D kanzi::animationInterpolate ( const SRTValue3D & from,
const SRTValue3D & to,
float phase )
inline

◆ animationInterpolate() [10/11]

SRTValue3DLongerPath kanzi::animationInterpolate ( const SRTValue3DLongerPath & from,
const SRTValue3DLongerPath & to,
float phase )
inline

◆ animationInterpolate() [11/11]

SRTValue2D kanzi::animationInterpolate ( const SRTValue2D & from,
const SRTValue2D & to,
float phase )
inline

◆ animationConcatenate() [1/5]

template<typename T >
T kanzi::animationConcatenate ( const T & lhs,
const T & rhs )

◆ animationConcatenate() [2/5]

bool kanzi::animationConcatenate ( bool lhs,
bool rhs )
inline

◆ animationConcatenate() [3/5]

ResourceSharedPtr kanzi::animationConcatenate ( ResourceSharedPtr ,
ResourceSharedPtr rhs )
inline

◆ animationConcatenate() [4/5]

SRTValue2D kanzi::animationConcatenate ( const SRTValue2D & lhs,
const SRTValue2D & rhs )
inline

◆ animationConcatenate() [5/5]

SRTValue3D kanzi::animationConcatenate ( const SRTValue3D & lhs,
const SRTValue3D & rhs )
inline

◆ registerTimelineLoaders()

void kanzi::registerTimelineLoaders ( ObjectLoader & objectLoader)

Registers loaders for build-in timeline types.

◆ convert() [1/2]

◆ convert() [2/2]

◆ load() [1/2]

void kanzi::load ( ApplicationProperties & applicationProperties,
string_view configurationFilePath )

Loads application properties from configuration INI file.

If property is not specified in configuration file, nothing will be written to appropriate field of application properties.

Parameters
applicationPropertiesApplication properties where loaded property values are written.
configurationFilePathPath to configuration file.

◆ load() [2/2]

void kanzi::load ( ApplicationProperties & applicationProperties,
const SystemProperties & systemProperties )

Loads application properties from system properties.

If property is not specified in system properties, nothing will be written to appropriate field of application properties.

Parameters
applicationPropertiesApplication properties where loaded property values are written.
systemPropertiesSystem properties where to read property values from.

◆ loadSettings()

void kanzi::loadSettings ( ApplicationProperties & applicationProperties,
const string_view configurationFilePath,
const SystemProperties & systemProperties )

Loads all properties, prioritizing command line parameters over configuration file parameters.

Parameters
applicationPropertiesApplication properties where loaded property values are written.
configurationFilePathPath to configuration file.
systemPropertiesSystem properties where to read property values from.

◆ parseValue() [1/11]

template<typename T >
T kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
T defaultValue )

◆ parseValue() [2/11]

template<>
int kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
int defaultValue )

◆ parseValue() [3/11]

template<>
optional< int > kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
optional< int > defaultValue )

◆ parseValue() [4/11]

template<>
optional< unsigned int > kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
optional< unsigned int > defaultValue )

◆ parseValue() [5/11]

template<>
unsigned int kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
unsigned int defaultValue )

◆ parseValue() [6/11]

template<>
string kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
string defaultValue )

◆ parseValue() [7/11]

template<>
SurfaceColorSpace kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
SurfaceColorSpace defaultValue )

◆ parseValue() [8/11]

template<>
WindowStyle kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
WindowStyle defaultValue )

◆ parseValue() [9/11]

template<>
EGLContextClientSelection kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
EGLContextClientSelection defaultValue )

◆ parseValue() [10/11]

template<>
EGLSurfaceType kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
EGLSurfaceType defaultValue )

◆ parseValue() [11/11]

template<>
optional< EGLIMGContextPriority > kanzi::parseValue ( const SystemConfiguration & configuration,
const string & key,
optional< EGLIMGContextPriority > defaultValue )

◆ parseQnxContextTypeValue()

int kanzi::parseQnxContextTypeValue ( const SystemConfiguration & configuration,
const string & key,
int defaultValue )

Parses QNX context type flags from the system configuration.

Parameters
configurationThe system configuration.
keyThe ConfigurationKeyQnxContextType key.
defaultValueThe value to use, if no configuration is found.
Since
Kanzi 3.9.10

◆ appendSkipSystemInitialization()

void kanzi::appendSkipSystemInitialization ( SystemProperties & systemProperties)

Adds "-nosysinit" to the end of the system properties.

Parameters
systemPropertiesSystem properties where skip system initialization property is added.

◆ hasSkipSystemInitialization()

bool kanzi::hasSkipSystemInitialization ( const SystemProperties & systemProperties)

Checks whether one of the parameters is "-nosysinit".

Parameters
systemPropertiesSystem properties where to look for the property.
Returns
Returns true if system properties contain the property, false otherwise.

◆ findConfigurationName()

string_view kanzi::findConfigurationName ( const SystemProperties & systemProperties,
string_view defaultConfigurationName )

Returns the tail of the first argument that starts with "-config=" or default configuration name if not found.

Parameters
systemPropertiesSystem properties where to look for the argument.
defaultConfigurationNameDefault configuration name which is returned if config argument is not found.
Returns
Returns configuration name from config argument.

◆ hasToken()

bool kanzi::hasToken ( const SystemProperties & systemProperties,
string_view token )

Checks if system properties contain specified token.

Parameters
systemPropertiesSystem properties where to look for the token.
tokenToken name.
Returns
Returns true if system properties contain the token, false otherwise.

◆ getRuntimeAssetDataSize()

size_t kanzi::getRuntimeAssetDataSize ( )

Gets size of runtime asset data.

Returns
Data size in bytes.

◆ getRuntimeAssetData()

const byte * kanzi::getRuntimeAssetData ( )

Gets runtime asset data.

Returns
Pointer to runtime asset data.

◆ registerRuntimeAssets()

void kanzi::registerRuntimeAssets ( Domain * domain)

Registers build-in runtime assets in resource manager of domain so they can be acquired at runtime.

Parameters
domainThe domain where to register runtime assets.

◆ setBindingToBindingHost()

BindingRuntimeHandle kanzi::setBindingToBindingHost ( HostType & bindingHost,
TemplateSharedPtrType templateRoot,
AbstractBindingSharedPtr binding,
AbstractPropertyType propertyType,
optional< PropertyValuePrecedence > precedence,
PropertyField field )

Helper function to set bindings to binding hosts.

Parameters
bindingHostBinding host to set the binding to.
templateRootTemplate root for setting the binding.
bindingThe binding to set.
propertyTypeTarget property type.
precedenceOptional precedence value.
fieldTarget property field.
Returns
Binding runtime handler created for the binding.
Since
Kanzi 3.9.7 changed AbstractBindingRuntimeSharedPtr to BindingRuntimeHandle.

◆ resolveDataType()

PropertyDataType kanzi::resolveDataType ( AbstractPropertyType propertyType,
PropertyField field )
inline

Resolve data type for a reading or writing.

Parameters
propertyTypeTarget property type.
fieldTarget property field.
Returns
Datatype of the property field or of the property if property field is 'whole'.

◆ bindingWriteObjectProperty()

template<typename T >
bool kanzi::bindingWriteObjectProperty ( PropertyObjectSharedPtr object,
const Variant & value,
AbstractPropertyType propertyType,
PropertyField field )

Writes an object property.

Parameters
objectObject to write to.
valueValue to write.
propertyTypeTarget property type.
fieldTarget property field.
Returns
True if writing the property succeeded, false otherwise.

◆ createDataObjectVariant() [1/2]

template<typename T >
Variant kanzi::createDataObjectVariant ( const T & value)

Creates a new Variant from data object value.

Required to wrap data types not supported by Variant.

Parameters
valueValue to create variant from.
Returns
Newly created variant

◆ createDataObjectVariant() [2/2]

Variant kanzi::createDataObjectVariant ( double value)
inline

◆ isValid()

bool kanzi::isValid ( GraphicsFormat format)

Indicates whether format is valid.

Parameters
formatgraphics format to query.
Returns
True if format is valid, otherwise false.

◆ getBitsPerBlock()

unsigned int kanzi::getBitsPerBlock ( GraphicsFormat format)

Returns number of bits per block of the specified format.

Parameters
formatGraphics format to query.
Returns
Number of bits per block of specified format. For GraphicsFormatNone, 0 is returned.

◆ getBytesPerBlock()

unsigned int kanzi::getBytesPerBlock ( GraphicsFormat format)

Returns number of bytes per block of the specified format.

Parameters
formatGraphics format to query.
Returns
Number of bytes per block of specified format. For GraphicsFormatNone, 0 is returned.
See also
getBitsPerBlock.

◆ isCompressed()

bool kanzi::isCompressed ( GraphicsFormat format)

Indicates whether format is compressed format or not.

Parameters
formatgraphics format to query.
Returns
True if format is compressed, otherwise false.

◆ getFallback()

GraphicsFormat kanzi::getFallback ( GraphicsFormat format)

Returns an alternative format which is potentially more widely supported.

Fallback format may have more bits for some or all of the component, but never less. Fallback format may have additional channels, fallback format may not drop any component. For example, if R8G8B8 texture format is not supported by graphics device. getFallback() returns R8G8B8A8 format since that is potentially more widely supported. Fallback format is a format which can represent all information of the given format.

Parameters
formatFormat for which fallback format is queried.
Returns
A fallback format for given format, or GraphicsFormatNone if no suitable format was found.

◆ getCommon()

GraphicsFormat kanzi::getCommon ( GraphicsFormat format1,
GraphicsFormat format2 )

Returns a common superset of two formats, or GraphicsFormatNone if formats cannot be combined.

The returned common format must have all channels from both given formats. For each channel, the number of bits must equal or exceed number of bits in the given formats.

Parameters
format1First format
format2Second format
Returns
Format that is compatible with both given formats. If there is no suitable format, returns GraphicsFormatNone.

◆ getSRGBFormat()

GraphicsFormat kanzi::getSRGBFormat ( GraphicsFormat format)

Returns an sRGB format that is compatible with the provided format.

Parameters
formatFormat for which sRGB format is queried.
Returns
A sRGB format for the given format, or the original format if no sRGB variant was found.

◆ getDataType()

GraphicsDataType kanzi::getDataType ( GraphicsFormat format)

Returns data type of the format.

Parameters
formatFormat to query.
Returns
Data type of given format.

◆ getChannelCount()

unsigned int kanzi::getChannelCount ( GraphicsFormat format)

Returns number of unique color channels of the format.

Parameters
formatFormat to query.
Returns
Number of unique color channels of given format. If the channel count cannot be determined from the graphics format, 0 is returned.

◆ getDataSizeBytes()

unsigned int kanzi::getDataSizeBytes ( int width,
int height,
GraphicsFormat format )

Returns data size in bytes for image with specified dimensions and format.

For block based images, number of blocks is calculated, and image size is returned as block size times number of blocks. For formats which are not block based, minimum byte-aligned stride size is calculated and height times stride size is returned.

Parameters
widthWidth of image.
heightHeight of image.
formatFormat of image.
Returns
Size of image of given size and format.

◆ hasColor()

bool kanzi::hasColor ( GraphicsFormat format)

Indicates whether given format has one more more color channels.

Red, green, blue, and luminance are considered color channels.

Parameters
formatFormat to query.
Returns
True if given format has any of the color channels.

◆ hasAlpha()

bool kanzi::hasAlpha ( GraphicsFormat format)

Indicates whether given format has alpha channel.

Parameters
formatFormat to query.
Returns
True if given format has alpha channel.

◆ hasDepth()

bool kanzi::hasDepth ( GraphicsFormat format)

Indicates whether given format has depth channel.

Parameters
formatFormat to query.
Returns
True if given format has depth channel.

◆ hasStencil()

bool kanzi::hasStencil ( GraphicsFormat format)

Indicates whether given format has stencil channel.

Parameters
formatFormat to query.
Returns
True if given format has stencil channel.

◆ hasAliasedChannel()

bool kanzi::hasAliasedChannel ( GraphicsFormat format)

Indicates whether given format has an aliased color channel.

Parameters
formatFormat to query.
Returns
True if given format has an aliased color channel.

◆ getBitCount() [1/2]

unsigned int kanzi::getBitCount ( GraphicsDataType dataType)

Return number of bits per one element of data type.

For GraphicsDataTypeNone, 0 is returned.

Parameters
dataTypeData type to query.
Returns
Number of bits in given data type.

◆ getBitCount() [2/2]

unsigned int kanzi::getBitCount ( GraphicsDataType dataType,
unsigned int componentCount )

Return number of bits per one element of data type.

For GraphicsDataTypeNone, 0 is returned.

Parameters
dataTypeData type to query.
componentCountNumber of components of the given data type in one element. If the data type is packed, this parameter is ignored and the return value is calculated from the data type alone.
Returns
Number of bits in given data type.

◆ getByteCount() [1/2]

unsigned int kanzi::getByteCount ( GraphicsDataType dataType)

Return number of bytes per one element of data type.

Parameters
dataTypeData type to query.
Returns
Number of bytes in given data type.
See also
getBitCount.

◆ isPacked()

bool kanzi::isPacked ( GraphicsDataType dataType)

Indicates whether given data type is packed or not.

Parameters
dataTypeData type to query.
Returns
True if data type is packed. otherwise false.

◆ getByteCount() [2/2]

unsigned int kanzi::getByteCount ( GraphicsDataType dataType,
unsigned int dimension )

Returns number of bytes for graphics data.

Parameters
dataTypeData type for elements.
dimensionNumber of components in one element. Ignored if dataType is packed.
Returns
Number of bytes in graphics data.
See also
getBitCount.

◆ toFixedString() [1/5]

FixedString kanzi::toFixedString ( GraphicsDataType dataType)

Returns human readable string for GraphicsDataType.

Parameters
dataTypeData type to query.
Returns
Human readable string for given graphics data type.

◆ toFixedString() [2/5]

FixedString kanzi::toFixedString ( GraphicsFormat format)

Returns human readable string for GraphicsFormat.

Parameters
formatFormat to query.
Returns
Human readable string for given graphics format.

◆ findGraphicsFormatByName()

optional< GraphicsFormat > kanzi::findGraphicsFormatByName ( string_view formatName)

Returns GraphicsFormat given its name as a human readable string.

Parameters
formatNameName of the format.
Returns
GraphicsFormat corresponding to the given format name. If the format cannot be found, nullopt is returned.

◆ getDefaultGraphicsFormatForColorSpace()

GraphicsFormat kanzi::getDefaultGraphicsFormatForColorSpace ( SurfaceColorSpace space)

Gets the default graphics format to represent a given surface color space.

Parameters
spaceA Surface color space
Returns
The Graphics Format used for a color space

◆ makeLegacyGraphicsOutput()

KZ_NO_DISCARD GraphicsOutputSharedPtr kanzi::makeLegacyGraphicsOutput ( const struct KzsSurfaceProperties * surfaceProperties,
const NativeWindowProperties * windowProperties,
const NativeDesktopProperties * desktopProperties )

Creates a legacy graphics output.

Parameters
surfacePropertiesProperties for the rendering surface.
windowPropertiesProperties for the window.
desktopPropertiesProperties for the desktop.
Returns
A new graphics output object. Returns nullptr on error.
Since
Kanzi 3.9.7 Added desktopProperties.

◆ makeDefaultGraphicsOutput()

KZ_NO_DISCARD GraphicsOutputSharedPtr kanzi::makeDefaultGraphicsOutput ( const SystemConfiguration & configuration)

Creates a platform-specific graphics output.

Parameters
configurationPlatform-specific configuration parameters. See your platform documentation for details.
Returns
A new graphics output object. Returns nullptr on error.

◆ combineCompositionRequirements()

CompositionRequirements kanzi::combineCompositionRequirements ( const CompositionRequirements & lhs,
const CompositionRequirements & rhs )
inline

Merge two composition requirements together.

In the combined requirement, all bits that are set in either one are set.

Parameters
lhsLeft-hand-side requirements.
rhsRight-hand-side requirements.

◆ getFullScreenTriangleGeometry()

GeometrySharedPtr kanzi::getFullScreenTriangleGeometry ( Domain * domain)

Gets a shared instance of full screen triangle.

The triangle covers the full NDC area from -1,-1 to 1,1, and vertices are defined as (-1,-1), (3,-1), (-1,3).

Do not modify the geometry instance, since the instance is shared globally within the same domain.

Parameters
domainDomain to use.
Returns
Shared pointer to default full screen triangle geometry.
Since
Kanzi 3.9.10.

◆ getUnitQuadGeometry()

GeometrySharedPtr kanzi::getUnitQuadGeometry ( Domain * domain)

Gets a shared instance of unit quad geometry.

Vertices and texture coordinates of the unit quad geometry span from 0,0 to 1,1.

Do not modify the geometry instance, since the instance is shared globally within the same domain.

Parameters
domainDomain to use.
Returns
Shared pointer to default quad geometry.
Since
Kanzi 3.9.5.

◆ isCompatibleWithUnitQuadGeometry()

bool kanzi::isCompatibleWithUnitQuadGeometry ( const QuadDescription & quadDescription,
Vector2 tiling )

Determines whether the given quad description and tiling are compatible with unit quad geometry.

Parameters
quadDescriptionQuad description to check.
tilingTiling multipliers.
Returns
If the quad description and tiling are compatible with unit quad geometry true, otherwise false.
Since
Kanzi 3.9.5.

◆ getUnitQuadTargetTransformation() [1/2]

Matrix3x3 kanzi::getUnitQuadTargetTransformation ( const RectangleFloat & targetRectangle)

Gets the 3x3 transformation that maps the unit quad geometry to the target rectangle.

Parameters
targetRectangleTarget rectangle for the quad geometry.
Returns
Transformation that includes the offset and size of the target rectangle.
Since
Kanzi 3.9.5.

◆ getUnitQuadTargetTransformation() [2/2]

Matrix3x3 kanzi::getUnitQuadTargetTransformation ( Vector2 offset,
Vector2 size )
inline

Gets the 3x3 transformation that maps the unit quad geometry to the target offset and size.

Parameters
offsetTarget rectangle offset.
sizeTarget rectangle size.
Returns
Transformation that includes the offset and size of the target rectangle.
Since
Kanzi 3.9.5.

◆ applyGeometryTargetRectangle() [1/2]

Matrix3x3 kanzi::applyGeometryTargetRectangle ( const Matrix3x3 & transformation,
const RectangleFloat & targetRectangle )

Applies offset and size of the target rectangle to 3x3 transformation.

Kanzi applies the offset and size of the target rectangle such that it is possible to use a unit quad in place of a custom quad, if otherwise compatible. See kanzi::isCompatibleWithUnitQuadGeometry.

Parameters
transformationTransformation to which to apply the offset and size.
targetRectangleTarget rectangle for the quad geometry.
Returns
Transformation that includes the offset and size of the target rectangle.
Since
Kanzi 3.9.5.

◆ applyGeometryTargetRectangle() [2/2]

Matrix4x4 kanzi::applyGeometryTargetRectangle ( const Matrix4x4 & transformation,
const RectangleFloat & targetRectangle )

Applies offset and size of the target rectangle to 4x4 transformation.

Kanzi applies the offset and size of the target rectangle such that it is possible to use a unit quad in place of a custom quad, if otherwise compatible. See kanzi::isCompatibleWithUnitQuadGeometry.

Parameters
transformationTransformation to which to apply the offset and size.
targetRectangleTarget rectangle for the quad geometry.
Returns
Transformation that includes the offset and size of the target rectangle.
Since
Kanzi 3.9.5.

◆ applyGeometryOffsetAndSize() [1/2]

Matrix3x3 kanzi::applyGeometryOffsetAndSize ( const Matrix3x3 & transformation,
Vector2 offset,
Vector2 size )
inline

Applies offset and size to 3x3 transformation.

Kanzi applies the offset and size such that it is possible to use a unit quad in place of a custom quad, if otherwise compatible. See kanzi::isCompatibleWithUnitQuadGeometry.

Parameters
transformationTransformation to which to apply the offset and size.
offsetTarget rectangle offset.
sizeTarget rectangle size.
Returns
Transformation that includes the offset and size of the target rectangle.
Since
Kanzi 3.9.5.

◆ applyGeometryOffsetAndSize() [2/2]

Matrix4x4 kanzi::applyGeometryOffsetAndSize ( const Matrix4x4 & transformation,
Vector2 offset,
Vector2 size )
inline

Applies offset and size of the target rectangle to 4x4 transformation.

Kanzi applies the offset and size such that it is possible to use a unit quad in place of a custom quad, if otherwise compatible. See kanzi::isCompatibleWithUnitQuadGeometry.

Parameters
transformationTransformation to which to apply the offset and size.
offsetTarget rectangle offset.
sizeTarget rectangle size.
Returns
Transformation that includes the offset and size of the target rectangle.
Since
Kanzi 3.9.5.

◆ toFixedString() [3/5]

FixedString kanzi::toFixedString ( Sampler::Filter filter)

◆ toFixedString() [4/5]

FixedString kanzi::toFixedString ( Sampler::MipmapMode mipmapMode)

◆ swap() [1/12]

void kanzi::swap ( Texture::CreateInfo & info1,
Texture::CreateInfo & info2 )
inline

◆ loadTextureCreateInfo()

Texture::CreateInfo kanzi::loadTextureCreateInfo ( Domain * domain,
KzbFile & kzbFile,
ReadOnlyMemoryFile & file,
KzbMemoryParser & parser )

Load texture create info from KZB file.

Parameters
domainDomain
kzbFileKZB file
fileFile
parserMemory parser
Returns
Texture create info

◆ getVerboseDescription() [1/2]

FixedString kanzi::getVerboseDescription ( Texture::CreateInfo::Status status)

Returns human readable description for CreateInfo status.

Parameters
statusStatus
Returns
human readable description for status.

◆ loadImage()

BitmapImageUniquePtr kanzi::loadImage ( Domain * domain,
string_view imageUrl,
bool isInCubemap )

Loads an image from KZB file.

Parameters
domainDomain.
imageUrlURL of the image.
isInCubemapWhether the loaded image will be used as a cubemap face.
Returns
The loaded image.

◆ getLightTypeForCollectionName()

Light::Type kanzi::getLightTypeForCollectionName ( string_view collectionName,
AbstractPropertyType propertyType,
string_view renderValueName )

Returns the light type based on the collection name or, if collection name is empty, on the property type.

Parameters
collectionNameName of the light type.
propertyTypeProperty type for which to get the light type.
renderValueNameName of the render value.
Returns
The light type.

◆ getInvalidLightValue()

bool kanzi::getInvalidLightValue ( Variant & value,
AbstractPropertyType propertyType )

Gets an 'invalid' value for a light that does not exist.

This value does not affect rendering.

Parameters
valueTarget variant to store the invalid value to.
propertyTypeProperty type to get the value for.
Returns
If an invalid value was successfully obtained, true, otherwise false.

◆ getSrcColorFactor()

constexpr BlendFactor kanzi::getSrcColorFactor ( int blendMode)
constexpr

Gets the source color factor.

Returns
Source color factor.
Since
Kanzi 3.9.1

◆ getSrcAlphaFactor()

constexpr BlendFactor kanzi::getSrcAlphaFactor ( int blendMode)
constexpr

Gets the source alpha factor.

Returns
Source alpha factor.
Since
Kanzi 3.9.1

◆ getDstColorFactor()

constexpr BlendFactor kanzi::getDstColorFactor ( int blendMode)
constexpr

Gets the destination color factor.

Returns
Destination color factor.
Since
Kanzi 3.9.1

◆ getDstAlphaFactor()

constexpr BlendFactor kanzi::getDstAlphaFactor ( int blendMode)
constexpr

Gets the destination alpha factor.

Returns
Destination alpha factor.
Since
Kanzi 3.9.1

◆ getBlendEquationColor()

constexpr BlendEquation kanzi::getBlendEquationColor ( int blendMode)
constexpr

Gets the color blend equation.

Returns
Color blend equation.
Since
Kanzi 3.9.1

◆ getBlendEquationAlpha()

constexpr BlendEquation kanzi::getBlendEquationAlpha ( int blendMode)
constexpr

Gets the alpha blend equation.

Returns
Alpha blend equation.
Since
Kanzi 3.9.1

◆ getBlendEquationAdvanced()

constexpr BlendEquationAdvanced kanzi::getBlendEquationAdvanced ( int blendMode)
constexpr

Gets the advanced blend equation.

Returns
Advanced blend equation.
Since
Kanzi 3.9.6

◆ isOpaquableBlendMode()

constexpr bool kanzi::isOpaquableBlendMode ( int blendMode)
constexpr

Indicates whether a blend mode can be rendered as opaque as substitute for clearing.

Returns
If the blend mode, when rendered on top of transparent black, produces the same result, true, otherwise false.
Since
Kanzi 3.9.1

◆ getIndexTypeStride()

size_t kanzi::getIndexTypeStride ( IndexBufferType type)
inline

Returns the stride of a given index type.

◆ isImplicitMultisampleSupport()

bool kanzi::isImplicitMultisampleSupport ( Multisample multisampleSupport)
inline

Tell if multisample support is of implicit type.

Implicit multisample does not require a separate resolve and does not have explicitly accessible samples.

Parameters
multisampleSupportMultisample support.
Returns
True if implicit multisample support, false if not.

◆ getFaceCount()

unsigned int kanzi::getFaceCount ( TextureType type)

Gets face count for a given texture type.

Parameters
typeTexture type.
Returns
Number of faces.

◆ swap() [2/12]

void kanzi::swap ( VertexAttribute & attribute1,
VertexAttribute & attribute2 )
inline

◆ swap() [3/12]

void kanzi::swap ( MeshVertexAttribute & attribute1,
MeshVertexAttribute & attribute2 )
inline

◆ swap() [4/12]

void kanzi::swap ( ShaderVertexAttribute & attribute1,
ShaderVertexAttribute & attribute2 )
inline

◆ toVertexAttributeSemantic()

optional< VertexAttribute::Semantic > kanzi::toVertexAttributeSemantic ( unsigned int kzbVertexAttributeSemantic)

Converts KZB vertex attribute semantic to runtime VertexAttribute::Semantic.

Parameters
kzbVertexAttributeSemanticKZB vertex attribute semantic value.
Returns
Runtime VertexAttribute Semantic.

◆ toFixedString() [5/5]

FixedString kanzi::toFixedString ( VertexAttribute::Semantic semantic)

Returns human readable string for semantic.

Parameters
semanticVertex attribute semantic.
Returns
Human readable string for semantic.

◆ swap() [5/12]

void kanzi::swap ( Mesh::CreateInfo::Cluster & cluster1,
Mesh::CreateInfo::Cluster & cluster2 )
inline

◆ swap() [6/12]

void kanzi::swap ( Mesh::CreateInfo & createInfo1,
Mesh::CreateInfo & createInfo2 )
inline

◆ writeVertexAttribute() [1/5]

void kanzi::writeVertexAttribute ( Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex,
unsigned int component,
float v )

Writes one float attribute component to vertex data.

Note
Only attributes with normalized or floating point data type are supported, packed data types are not supported by this function.
Parameters
createInfoMesh create info to edit.
vertexIndexVertex to modify.
attributeIndexVertex attribute to modify.
componentIndex of attribute component to modify.
vValue for vertex attribute component.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ writeVertexAttribute() [2/5]

void kanzi::writeVertexAttribute ( Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex,
float v )

Writes one float attribute value to vertex data.

Note
Only attributes with normalized or floating point data type are supported.
Parameters
createInfoMesh create info to edit.
vertexIndexVertex to modify.
attributeIndexVertex attribute to modify.
vValue for vertex attribute.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ writeVertexAttribute() [3/5]

void kanzi::writeVertexAttribute ( Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex,
Vector2 v )

Writes one Vector2 attribute value to vertex data.

Note
Only attributes with normalized or floating point data type are supported.
Parameters
createInfoMesh create info to edit.
vertexIndexVertex to modify.
attributeIndexVertex attribute to modify.
vValue for vertex attribute.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ writeVertexAttribute() [4/5]

void kanzi::writeVertexAttribute ( Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex,
Vector3 v )

Writes one Vector3 attribute value to vertex data.

Note
Only attributes with normalized or floating point data type are supported.
Parameters
createInfoMesh create info to edit.
vertexIndexVertex to modify.
attributeIndexVertex attribute to modify.
vValue for vertex attribute.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ writeVertexAttribute() [5/5]

void kanzi::writeVertexAttribute ( Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex,
Vector4 v )

Writes one Vector3 attribute value to vertex data.

Note
Only attributes with normalized or floating point data type are supported.
Parameters
createInfoMesh create info to edit.
vertexIndexVertex to modify.
attributeIndexVertex attribute to modify.
vValue for vertex attribute.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ readVertexAttributeComponent()

float kanzi::readVertexAttributeComponent ( const Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex,
unsigned int component )

Reads one attribute component of given vertex from mesh create info.

Note
Only attributes with normalized or floating point data type are supported. Packed data types are not supported by this function.
Parameters
createInfoMesh create info to read.
vertexIndexVertex to read.
attributeIndexVertex attribute to read.
componentIndex of attribute component to read.
Returns
Value of vertex attribute of given vertex.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ readVertexAttributeFloat()

float kanzi::readVertexAttributeFloat ( const Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex )

Reads float attribute of given vertex from mesh.

Note
Only attributes with normalized or floating point data type are supported. Packed data types are not supported by this function.
Parameters
createInfoMesh create info to read.
vertexIndexVertex to read.
attributeIndexVertex attribute to read.
Returns
Value of float attribute of given vertex.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ readVertexAttributeVector2()

Vector2 kanzi::readVertexAttributeVector2 ( const Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex )

Reads Vector2 attribute of given vertex from mesh.

Note
Only attributes with normalized or floating point data type are supported. Packed data types are not supported by this function.
Parameters
createInfoMesh create info to read.
vertexIndexVertex to read.
attributeIndexVertex attribute to read.
Returns
Value of Vector2 attribute of given vertex.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ readVertexAttributeVector3()

Vector3 kanzi::readVertexAttributeVector3 ( const Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex )

Reads Vector3 attribute of given vertex from mesh.

Note
Only attributes with normalized or floating point data type are supported.
Parameters
createInfoMesh create info to read.
vertexIndexVertex to read.
attributeIndexVertex attribute to read.
Returns
Value of Vector3 attribute of given vertex.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ readVertexAttributeVector4()

Vector4 kanzi::readVertexAttributeVector4 ( const Mesh::CreateInfo & createInfo,
unsigned int vertexIndex,
unsigned int attributeIndex )

Reads Vector4 attribute of given vertex from mesh.

Note
Only attributes with normalized or floating point data type are supported.
Parameters
createInfoMesh create info to read.
vertexIndexVertex to read.
attributeIndexVertex attribute to read.
Returns
Value of Vector4 attribute of given vertex.
Since
Kanzi 3.9.7 changed the type of the index parameters to unsigned int.

◆ loadMeshCreateInfo()

Mesh::CreateInfo kanzi::loadMeshCreateInfo ( Domain * domain,
KzbFile & kzbFile,
ReadOnlyMemoryFile & file,
KzbMemoryParser & parser )

Loads mesh create info from KZB.

Parameters
domainDomain for mesh.
kzbFileKZB file to load from.
fileMemory file corresponding to KZB file.
parserKZB data parser.
Returns
Mesh create info.

◆ calculateBoundingVolume()

Box kanzi::calculateBoundingVolume ( const Mesh::CreateInfo & createInfo)

Calculates bounding box from mesh vertex data.

Parameters
createInfoMesh create info.
Returns
Bounding box for mesh vertex attributes with Position semantic.

◆ updateVertexAttributeOffsetsAndVertexSize()

void kanzi::updateVertexAttributeOffsetsAndVertexSize ( Mesh::CreateInfo & createInfo)

Sets offsets for vertex attributes in mesh create info.

Parameters
createInfoMesh create info.

◆ updateVertexAttributeStrides()

void kanzi::updateVertexAttributeStrides ( Mesh::CreateInfo & createInfo)

Calculates vertex format size and updates stride to all vertex attributes in mesh create info.

Parameters
createInfoMesh create info.

◆ collectResourceUrls() [1/8]

ResourceManager::UrlContainer kanzi::collectResourceUrls ( const Mesh::CreateInfo & createInfo)

For each cluster in mesh create info, get material URL, if set.

Parameters
createInfoMesh create info.
Returns
Container with material URLs.

◆ acquireResources()

void kanzi::acquireResources ( Domain * domain,
Mesh::CreateInfo & createInfo )

For each cluster in mesh create info, load material from materialURL, if set.

Parameters
domainThe domain to which the mesh belongs.
createInfoMesh create info.

◆ generateBox() [1/2]

Mesh::CreateInfo kanzi::generateBox ( Vector3 size,
unsigned int subdivisions,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
bool insideOut,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )

Makes mesh create info for a box primitive mesh.

The box has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
sizeThe size of the box.
subdivisionsThe number of subdivisions to apply to the box. The number of tiles in each face of the box is (subdivisions+1)^2.
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
insideOutWhether to generate faces with flipped winding and normals. Set to true when you want to use the mesh as a skybox.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for box.
Since
Kanzi 3.9.9 added insideOut parameter.

◆ generateBox() [2/2]

Mesh::CreateInfo kanzi::generateBox ( Vector3 size,
unsigned int subdivisions,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )
inline

Makes mesh create info for a box primitive mesh.

The box has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
sizeThe size of the box.
subdivisionsThe number of subdivisions to apply to the box. The number of tiles in each face of the box is (subdivisions+1)^2.
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for box.

◆ generateSphere() [1/2]

Mesh::CreateInfo kanzi::generateSphere ( float radius,
unsigned int segmentCount,
unsigned int rowCount,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
bool insideOut,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )

Makes mesh create info for a UV sphere primitive mesh.

The sphere has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
radiusThe radius of the sphere.
segmentCountThe number of segments in the UV sphere.
rowCountThe number of rows in the UV sphere.
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
insideOutWhether to generate faces with flipped winding and normals. Set to true when you want to use the mesh as a skybox.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for UV sphere.
Since
Kanzi 3.9.9 added insideOut parameter.

◆ generateSphere() [2/2]

Mesh::CreateInfo kanzi::generateSphere ( float radius,
unsigned int segmentCount,
unsigned int rowCount,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )
inline

Makes mesh create info for a UV sphere primitive mesh.

The sphere has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
radiusThe radius of the sphere.
segmentCountThe number of segments in the UV sphere.
rowCountThe number of rows in the UV sphere.
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for UV sphere.

◆ generateIcosphere() [1/2]

Mesh::CreateInfo kanzi::generateIcosphere ( float radius,
unsigned int subdivisions,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
bool insideOut,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )

Makes mesh create info for an icosphere primitive mesh.

The sphere has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
radiusThe radius of the sphere.
subdivisionsThe number of subdivisions to apply on top of the most basic icosphere, an icosahedron. The number of triangles in the sphere is 4 * (2 * subdivisions + 2) * (2 * subdivisions + 4).
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
insideOutWhether to generate faces with flipped winding and normals. Set to true when you want to use the mesh as a skybox.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for icosphere.
Since
Kanzi 3.9.9 added insideOut parameter.

◆ generateIcosphere() [2/2]

Mesh::CreateInfo kanzi::generateIcosphere ( float radius,
unsigned int subdivisions,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )
inline

Makes mesh create info for an icosphere primitive mesh.

The sphere has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
radiusThe radius of the sphere.
subdivisionsThe number of subdivisions to apply on top of the most basic icosphere, an icosahedron. The number of triangles in the sphere is 4 * (2 * subdivisions + 2) * (2 * subdivisions + 4).
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for icosphere.
Since
Kanzi 3.9.4

◆ generateQuadsphere() [1/2]

Mesh::CreateInfo kanzi::generateQuadsphere ( float radius,
unsigned int subdivisions,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
bool insideOut,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )

Makes mesh create info for a quad sphere primitive mesh.

The sphere has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
radiusThe radius of the sphere.
subdivisionsThe number of subdivisions to apply on top of the most basic quad sphere. The number of triangles in the sphere is 12 * (subdivisions + 1)^2.
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
insideOutWhether to generate faces with flipped winding and normals. Set to true when you want to use the mesh as a skybox.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for quad sphere.
Since
Kanzi 3.9.9 added insideOut parameter.

◆ generateQuadsphere() [2/2]

Mesh::CreateInfo kanzi::generateQuadsphere ( float radius,
unsigned int subdivisions,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )
inline

Makes mesh create info for a quad sphere primitive mesh.

The sphere has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
radiusThe radius of the sphere.
subdivisionsThe number of subdivisions to apply on top of the most basic quad sphere. The number of triangles in the sphere is 12 * (subdivisions + 1)^2.
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for quad sphere.
Since
Kanzi 3.9.4

◆ generatePlane()

Mesh::CreateInfo kanzi::generatePlane ( float width,
float height,
unsigned int subdivisions,
bool invertU,
bool invertV,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )

Makes mesh create info for a plane primitive mesh.

The plane has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
widthThe width of the plane.
heightThe height of the plane.
subdivisionsThe number of subdivisions to apply to the plane. The number of tiles in the plane is (subdivisions+1)^2.
invertUWhether to invert the U texture coordinate.
invertVWhether to invert the V texture coordinate.
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for plane.

◆ generateCone() [1/2]

Mesh::CreateInfo kanzi::generateCone ( float bottomRadius,
unsigned int bottomSegmentCount,
float height,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
bool insideOut,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )

Makes mesh create info for a UV cone primitive mesh.

The cone has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
bottomRadiusRadius of the lower circumference of the cone.
bottomSegmentCountThe number of segments in the lower circumference of the UV cone.
heightThe height of the cone. The number of triangles in the cone is 2 * bottomSegmentCount.
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
insideOutWhether to generate faces with flipped winding and normals. Set to true when you want to use the mesh as a skybox.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for UV cone.
Since
Kanzi 3.9.9

◆ generateCone() [2/2]

Mesh::CreateInfo kanzi::generateCone ( float bottomRadius,
unsigned int bottomSegmentCount,
float height,
bool useHalfFloat,
bool generateNormals,
bool generateTangents,
MaterialSharedPtr material,
string_view materialURL,
GPUResource::MemoryType memoryType )
inline

Makes mesh create info for a UV cone primitive mesh.

The cone has position, normal, and texture coordinate attributes in one cluster and it uses a specified material.

Parameters
bottomRadiusRadius of the lower circumference of the cone.
bottomSegmentCountThe number of segments in the lower circumference of the UV cone.
heightThe height of the cone. The number of triangles in the cone is 2 * bottomSegmentCount.
useHalfFloatWhether to use half-float data type for the vertex attributes. To use float data type, pass false.
generateNormalsWhether to generate normals data for the mesh.
generateTangentsWhether to generate tangents data for the mesh.
materialPointer to the Material that the mesh uses.
materialURLThe kzb URL of the material that the mesh uses.
memoryTypeMemory upload and RAM preservation strategy for the GPU resources of the mesh.
Returns
Mesh create info for UV cone.
Since
Kanzi 3.9.9

◆ getNodeListBindingSourcePath()

string kanzi::getNodeListBindingSourcePath ( const RenderPass & renderPass)

Gets the input path for a render pass to use with a node list binding.

If the NodeListRenderPass::InputNodeListProperty is set for the render pass, its value provides the input path. If the NodeListRenderPass::InputNodeListProperty is not set, the input path is either the nearest Node List Render Pass in the binding tree, or the Viewport 2D node that uses the render passes that the node list binding targets.

Parameters
renderPassThe render pass in which to look.
Returns
The path to use for the node list input binding.

◆ updateObjectSourceRuntime()

ObjectSourceRuntimeSharedPtr kanzi::updateObjectSourceRuntime ( ObjectSourceRuntimeSharedPtr runtime,
NodeListSharedPtr nodeList,
ObjectSourceSharedPtr filter )

Updates an existing filter runtime or returns a new one.

If the existing filter does not match the node list or filter, a new filter runtime is created.

Parameters
runtimeFilter runtime to update.
nodeListNode list to filter.
filterFilter that should have created the runtime.
Returns
Existing filter runtime if it's pointing to the same list, or a newly created runtime.

◆ unregisterRenderEntry()

void kanzi::unregisterRenderEntry ( DrawObjectsRenderPass & drawPass,
Node3D & node )

Remove references of node render entries from a draw objects render pass.

Parameters
drawPassDraw pass to remove from.
nodeNode to clear.

◆ getRoot() [1/3]

RenderPass * kanzi::getRoot ( RenderPass & renderPass)

Gets the render pass of the graph render pass belongs to.

Parameters
renderPassRender pass within the graph the root of which should be found.
Returns
Root render pass graph.

◆ to_string() [1/12]

string kanzi::to_string ( RenderPass::AttachmentState attachmentState)

Returns a string representation of an attachment state.

Parameters
attachmentStateRenderPass attachment state.
Returns
String representation of the attachment state.

◆ matrixMultiplyAffineGetTranslationZ()

float kanzi::matrixMultiplyAffineGetTranslationZ ( const kanzi::Matrix4x4 & lhs,
const kanzi::Matrix4x4 & rhs )

Gets translation Z component from product of two matrices, where both are affine transformations.

Parameters
lhsLeft-side multiplication component.
rhsRight-side multiplication component.
Returns
The translation Z component.

◆ KZ_ENABLE_BITMASK_OPERATORS() [1/4]

kanzi::KZ_ENABLE_BITMASK_OPERATORS ( FocusScope::ScopeFlag )

◆ matchModifiers()

KeyMatchResult kanzi::matchModifiers ( KeyModifier required,
const KeyEvent & event )

Returns whether the modifiers of the key event match the required modifiers.

For example, if the required modifiers have KeyModifier::Shift set, the KeyModifier::LeftShift and KeyModifier::RightShift flags are matched as well.

Parameters
requiredThe required modifiers to check.
eventThe key input event to check against the required modifiers.
Returns
If the KeyEvent modifiers match the required modifiers, true, otherwise false.
Since
Kanzi 3.8.0

◆ matchKeyGesture()

KeyMatchResult kanzi::matchKeyGesture ( const KeyGestureInfo & gesture,
const KeyEvent & event )

Detects key gestures from the event that you pass as an argument.

Call this function to detect a key gesture from a key event.

Parameters
gestureThe gesture to detect from the event.
eventThe event to detect the key gesture.
Returns
The test results.
See also
KeyMatch
Since
Kanzi 3.9.0

◆ makeLegacyEventSource()

EventSourceSharedPtr kanzi::makeLegacyEventSource ( const EventSourceProperties & properties,
GraphicsOutput * graphicsOutput )

Creates a legacy event source.

Parameters
propertiesProperties for the event source.
graphicsOutputPointer to the associated legacy graphics output.
Returns
A new event source object. Returns nullptr on error.

◆ makeDefaultEventSource()

EventSourceSharedPtr kanzi::makeDefaultEventSource ( const SystemConfiguration & configuration)

Creates a platform-specific event source.

Parameters
configurationPlatform-specific configuration parameters. See your platform documentation for details.
Returns
A new event source object. Returns nullptr on error.

◆ rayPickHitTest() [1/2]

RayPickResult kanzi::rayPickHitTest ( const Vector2 & limits,
Scene * scene,
Camera * camera,
int x,
int y )

Input hit testing.

Finds the closest visible node that was pointed.

Parameters
limitsThe size vector of a node.
sceneThe Scene node to render.
cameraActive hit test camera.
xX axis coordinate of a hit test point.
yY axis coordinate of a hit test point.
Returns
A tuple that contains the hit information.

◆ rayPickHitTest() [2/2]

KZ_DEPRECATED RayPickResult kanzi::rayPickHitTest ( const Vector2 & limits,
OverlayScope & scope,
Scene * scene,
Camera * camera,
int x,
int y )

Input hit testing.

Finds the closest visible node that was pointed in the focus scope passed as argument.

Parameters
limitsThe size vector of a node.
scopeThe focus scope that limits the hit test node lookup.
sceneThe Scene node to render.
cameraActive hit test camera.
xX axis coordinate of a hit test point.
yY axis coordinate of a hit test point.
Returns
A tuple that contains the hit information.
See also
ModalScope
Since
Kanzi 3.7.0
Deprecated
In Kanzi 3.9.2. Use rayPickHitTest() instead.

◆ getSupportedKzbFormatVersion()

uint32_t kanzi::getSupportedKzbFormatVersion ( )

Gets the supported kzb format version.

Returns
The kzb format version number.

◆ getKzbMagic()

ConstByteSpan kanzi::getKzbMagic ( )

Gets the kzb magic byte sequence.

Returns
The kzb magic byte sequence.

◆ isKzbMagic() [1/2]

bool kanzi::isKzbMagic ( ConstByteSpan data)

Returns whether the beginning of a byte span matches a kzb magic byte sequence.

Parameters
dataData to test.
Returns
If the value matches kzb magic byte sequence, returns True, otherwise False.

◆ isKzbMagic() [2/2]

bool kanzi::isKzbMagic ( File & file)

Returns whether the beginning of a file matches a kzb magic byte sequence.

Parameters
fileFile to test.
Returns
If the beginning of a file matches a kzb magic byte sequence, returns True, otherwise False.

◆ collectResourceUrls() [2/8]

UrlContainer kanzi::collectResourceUrls ( const KzbMemoryParser::PropertyContainer & properties)

Collects URLs of all property values of Resource type.

Parameters
propertiesReference to a PropertyContainer.

◆ applyProperties()

void kanzi::applyProperties ( Object & object,
const KzbMemoryParser::PropertyContainer & properties )

Apply properties from a PropertyContainer to an Object.

Synchronously acquire any property values of Resource type.

Parameters
objectReference to an object.
propertiesReference to a PropertyContainer.

◆ previewPatch()

void kanzi::previewPatch ( Domain * domain,
unique_ptr< KzbFile > patch )

◆ getTreeHeight()

unsigned int kanzi::getTreeHeight ( const Node & node)

Gets tree height from the object node to the parent.

If no parents, height = 1, if single parent, and parent's parent is null, height = 2 and so on.

Parameters
nodeNode the tree height of which to get.
Returns
Tree height of node.

◆ getRelativePath()

optional< string > kanzi::getRelativePath ( const Node & targetNode,
const Node & baseNode )

Gets the relative path from base object node to target object node, or nullopt if path could not be found.

Parameters
targetNodeNode the path to which to get.
baseNodeNode the patch from which to get.
Returns
Path from base node to target node or nullopt.

◆ findCommonParent()

Node * kanzi::findCommonParent ( const Node & nodeA,
const Node & nodeB )

Gets first common parent from nodeA and nodeB, or null if not found.

Parameters
nodeANode the common parent of which with nodeB to find.
nodeBNode the common parent of which with nodeA to find.
Returns
First common parent of nodeA and nodeB or null.

◆ getRoot() [2/3]

Node * kanzi::getRoot ( Node & node)

Gets the root node of the node tree to which the node belongs.

If the node does not belong to any node tree, returns null.

Parameters
nodeNode the root node of which to find.
Returns
Root node of the node tree or null.

◆ getRoot() [3/3]

const Node * kanzi::getRoot ( const Node & node)

Gets the root node of the node tree to which the node belongs.

If the node does not belong to any node tree, returns null.

Parameters
nodeNode the root node of which to find.
Returns
Root node of the node tree or null.

◆ isParentOf()

bool kanzi::isParentOf ( const Node & child,
const Node & parent )

Indicates whether one node is the parent of another node.

Parameters
childNode to indicate whether it belongs to the parent node.
parentNode to indicate whether it has the child node as its child.
Returns
True if the child node is child of the parent node, false otherwise.

◆ isAncestorOf()

bool kanzi::isAncestorOf ( const Node & node,
const Node & ancestor )

Indicates whether one node is the ancestor of another node at any level in the node tree.

Parameters
nodeNode to indicate whether it is the descendant of the ancestor node.
ancestorNode to indicate whether it is the ancestor of the descendant node.
Returns
True if the ancestor node is the parent of the node at any level, false otherwise.

◆ findParent()

template<typename Type >
shared_ptr< Type > kanzi::findParent ( const Node & node)

Gets nearest parent of specified type.

Parameters
nodeNode whose parent to get.
Returns
Parent node of specified type of the node.

◆ canNodeGetFocus()

bool kanzi::canNodeGetFocus ( const Node & node)

Returns whether a node can get the key focus.

A node can get the key focus if it

  • has Node::FocusableProperty attached and set to true,
  • is attaching or it is already attached,
  • is not detaching, and
  • is effectively enabled and is visible.
Parameters
nodeThe node for which to check whether it can get the key focus.
Returns
If the node can get the key focus, true, otherwise false.
Since
Kanzi 3.9.1 The node can get the key focus even if it is not effectively visible.

◆ nodeLookAt()

void kanzi::nodeLookAt ( Node3D & node,
Vector3 position,
Vector3 lookAtPoint,
Vector3 upVector )

Sets node transformation so that the node is in a given position turned toward a given point.

Parameters
nodeThe node to which to apply the transformation.
positionThe translation to apply to the node.
lookAtPointThe point toward which the node turns.
upVectorThe up vector to set for the node.

◆ registerDefaultTypes()

void kanzi::registerDefaultTypes ( ObjectFactory & objectFactory)

Registers default Kanzi object types in object factory.

◆ findFirstMatchEGLConfig()

KZ_NO_DISCARD::EGLConfig kanzi::findFirstMatchEGLConfig ( const EGLDisplay & eglDisplay,
const EGLCapabilities & requiredCapabilities )
noexcept

Finds the first EGL configuration that matches the capabilities, returns no config if no matches are found.

Parameters
eglDisplayThe EGL display connection to find configurations from.
requiredCapabilitiesThe capabilities that the configuration must be able to support.
Returns
Native EGL configuration handle.

◆ getEGLConfig()

KZ_NO_DISCARD::EGLConfig kanzi::getEGLConfig ( const EGLDisplay & eglDisplay,
const EGLCapabilities & requiredCapabilities )
noexcept

Gets the EGL configuration matching with the graphics format ID, if specified, otherwise finds the first EGL configuration that matches the capabilities.

Halts on failure.

Parameters
eglDisplayThe EGL display connection for which to find configurations.
requiredCapabilitiesThe capabilities that the configuration must be able to support, if no graphics format ID is specified.
Returns
Native EGL configuration handle.

◆ isGLES1FlagSet()

KZ_NO_DISCARD bool kanzi::isGLES1FlagSet ( int glesFlags)
noexcept

Tests whether OpenGL ES1 is supported.

Parameters
glesFlagsThe flags to test. Must be an attribute value of EGL_CONFORMANT or EGL_RENDERABLE_TYPE.
Returns
True if given flags has support for OpenGL ES1, false if not.

◆ isGLES2FlagSet()

KZ_NO_DISCARD bool kanzi::isGLES2FlagSet ( int glesFlags)
noexcept

Tests whether OpenGL ES2 is supported.

Parameters
glesFlagsThe flags to test. Must be an attribute value of EGL_CONFORMANT or EGL_RENDERABLE_TYPE.
Returns
true if given flags has support for OpenGL ES2, false if not.

◆ isGLES3FlagSet()

KZ_NO_DISCARD bool kanzi::isGLES3FlagSet ( int glesFlags)
noexcept

Tests whether OpenGL ES3 is supported.

Parameters
glesFlagsThe flags to test. Must be an attribute value of EGL_CONFORMANT or EGL_RENDERABLE_TYPE.
Returns
True if given flags has support for OpenGL ES3, false if not.

◆ supportsContextClientVersion()

KZ_NO_DISCARD bool kanzi::supportsContextClientVersion ( const EGLDisplay & eglDisplay,
const ::EGLConfig eglConfig,
EGLContextClientVersion version )
noexcept

Returns whether EGLConfig supports EGLContextClientVersion.

Parameters
eglDisplayEGL display.
eglConfigThe EGL configuration to use.
versionThe EGL context client version to use.
Returns
If the EGL configuration supports the selected EGL context client version, true, otherwise false.
Since
Kanzi 3.9.10

◆ findHighestContextClientVersion() [1/2]

KZ_NO_DISCARD optional< EGLContextClientVersion > kanzi::findHighestContextClientVersion ( const EGLDisplay & eglDisplay,
const span< ::EGLConfig > eglConfigs )
noexcept

Returns the highest context client version supported by at least one EGL configuration.

Parameters
eglDisplayEGL display.
eglConfigsA collection of EGL configurations.
Return values
nulloptNone of the EGL context client versions are supported.
Returns
The highest supported context client version.
Since
Kanzi 3.9.10

◆ findHighestContextClientVersion() [2/2]

KZ_NO_DISCARD optional< EGLContextClientVersion > kanzi::findHighestContextClientVersion ( const EGLDisplay & eglDisplay,
const ::EGLConfig eglConfig )
noexcept

Returns the highest context client version supported by an EGL configuration.

Parameters
eglDisplayEGL display.
eglConfigThe EGL configuration to use.
Return values
nulloptNone of the EGL context client versions are supported.
Returns
The highest supported context client version.
Since
Kanzi 3.9.10

◆ listAllEGLConfigsFromDefaultDisplay()

void kanzi::listAllEGLConfigsFromDefaultDisplay ( )
noexcept

Lists available EGL configurations for the default EGL display.

◆ isNoConfigHandle()

KZ_NO_DISCARD bool kanzi::isNoConfigHandle ( const ::EGLConfig eglConfig)
noexcept

Tests whether the given EGL configuration handle is no configuration.

Parameters
eglConfigEGL configuration handle to test.
Returns
True if given handle is a no configuration, false if not.

◆ isNoConfig()

KZ_NO_DISCARD bool kanzi::isNoConfig ( const EGLConfig & eglConfig)
noexcept

Tests whether the given EGL configuration is no configuration.

Parameters
eglConfigEGL configuration to test.
Returns
True if given configuration is a no configuration, false if not.

◆ listAllEGLConfigs()

void kanzi::listAllEGLConfigs ( const EGLDisplay & eglDisplay)
noexcept

Prints metadata for all EGL configurations supported by an EGL display.

Metadata for each configuration will be printed to stdout on a separate line. The configuration can be identified using the "Graphics format ID" parameter, which is unique for each configuration.

Parameters
eglDisplayEGL display to use.
Precondition
eglDisplay cannot be a no display.

◆ listEGLConfig()

void kanzi::listEGLConfig ( const EGLDisplay & eglDisplay,
const EGLConfig & eglConfig )
noexcept

Prints metadata for the given EGL configuration.

Parameters
eglDisplayEGL display in use.
eglConfigEGL configuration to list.
Precondition
eglDisplay cannot be a no display.
eglConfig cannot be a no configuration.
Since
Kanzi 3.9.8

◆ isNoContextHandle()

KZ_NO_DISCARD bool kanzi::isNoContextHandle ( const ::EGLContext eglContextHandle)
noexcept

Tests if a given EGL context handle is no context.

Parameters
eglContextHandleEGL context handle to test.
Returns
True if given handle is a no context, false if not.

◆ isNoContext()

KZ_NO_DISCARD bool kanzi::isNoContext ( const EGLContext & eglContext)
noexcept

Tests if a given EGL context is no context.

Parameters
eglContextEGL context to test.
Returns
True if given context is a no context, false if not.

◆ createEGLContextForClientVersion()

KZ_NO_DISCARD EGLContext kanzi::createEGLContextForClientVersion ( const EGLDisplay & eglDisplay,
const EGLConfig & eglConfig,
EGLContextClientSelection contextClientSelection )

Creates an EGL context for a given context client version.

The new context shares data with the currently active context in the same thread.

Parameters
eglDisplayEGL display connection.
eglConfigEGL configuration to use.
contextClientSelectionEGL context client selection object.
Returns
EGL context.
Since
Kanzi 3.9.10 changed contextClientVersion to contextClientSelection that expects EGLContextClientSelection.

◆ KZ_ENABLE_BITMASK_OPERATORS() [2/4]

kanzi::KZ_ENABLE_BITMASK_OPERATORS ( EGLContextClientVersion )

◆ isNoDisplayHandle()

KZ_NO_DISCARD bool kanzi::isNoDisplayHandle ( const ::EGLDisplay eglDisplay)
noexcept

Tests if a given EGL display handle is no display.

Parameters
eglDisplayEGL display handle to test.
Returns
True if given handle is a no display, false if not.

◆ isNoDisplay()

KZ_NO_DISCARD bool kanzi::isNoDisplay ( const EGLDisplay & eglDisplay)
noexcept

Tests if a given EGL display is no display.

Parameters
eglDisplayEGL display to test.
Returns
True if given display is a no display, false if not.

◆ makeCurrentEGLContext() [1/3]

bool kanzi::makeCurrentEGLContext ( const EGLDisplay & eglDisplay,
const EGLWindowSurface & eglSurface,
const EGLContext & eglContext )
noexcept

Binds a window surface to a context and the current thread.

Parameters
eglDisplayEGL display connection of the EGL context.
eglSurfaceWindow surface to bind.
eglContextEGL context to bind to.
Returns
True on success, false on failure.

◆ makeCurrentEGLContext() [2/3]

bool kanzi::makeCurrentEGLContext ( const EGLDisplay & eglDisplay,
const EGLPBufferSurface & eglSurface,
const EGLContext & eglContext )
noexcept

Binds a pbuffer surface to a context and the current thread.

Parameters
eglDisplayEGL display connection of the EGL context.
eglSurfacePbuffer surface to bind.
eglContextEGL context to bind to.
Returns
True on success, false on failure.

◆ makeCurrentEGLContext() [3/3]

bool kanzi::makeCurrentEGLContext ( const EGLDisplay & eglDisplay,
const EGLPixmapSurface & eglSurface,
const EGLContext & eglContext )
noexcept

Binds a pixmap surface to a context and the current thread.

Parameters
eglDisplayEGL display connection of the EGL context.
eglSurfacePixmap surface to bind.
eglContextEGL context to bind to.
Returns
True on success, false on failure.

◆ releaseCurrentEGLContext()

bool kanzi::releaseCurrentEGLContext ( const EGLDisplay & eglDisplay)
noexcept

Releases surfaces and context bound to the current thread.

Parameters
eglDisplayEGL display connection.
Returns
True on success, false on failure.

◆ shutdownEGL()

bool kanzi::shutdownEGL ( EGLDisplay & eglDisplay)
noexcept

Terminates current EGL display connection.

If surfaces or a context is currently bound to the current thread they are released first.

Parameters
eglDisplayEGL display connection to close.
Returns
True on success, false on failure.

◆ tryGetEGLAttributeValue()

KZ_NO_DISCARD optional< EGLint > kanzi::tryGetEGLAttributeValue ( const EGLDisplay & eglDisplay,
::EGLConfig eglConfig,
EGLint attributeName )
noexcept

Tries to get an EGL attribute value associated with the attribute name.

Parameters
eglDisplayEGL display connection to use.
eglConfigEGL config to query.
attributeNameAttribute name associated with the attribute value.
Return values
nulloptGetting the EGL attribute value has failed.
Returns
EGL attribute value.

◆ isNoSurface() [1/2]

bool kanzi::isNoSurface ( const EGLPixmapSurface & eglSurface)
noexcept

Tests if a given EGL surface is a no surface.

Parameters
eglSurfaceEGL surface to test.
Returns
True if given surface is a no surface, false if not.
Since
Kanzi 3.9.10

◆ isNativePixmapSurfaceConfigSupported()

bool kanzi::isNativePixmapSurfaceConfigSupported ( const EGLDisplay & eglDisplay,
EGLNativePixmapType eglNativePixmap,
const EGLConfig & eglConfig )
noexcept

Tests if a given EGL config is a valid pixmap surface configuration.

Parameters
eglDisplayEGL display connection.
eglNativePixmapPixmap to attach test surface to.
eglConfigEGL config to test.
Returns
True if given config is a valid surface configuration, false if not.
Since
Kanzi 3.9.10

◆ KZ_ENABLE_BITMASK_OPERATORS() [3/4]

kanzi::KZ_ENABLE_BITMASK_OPERATORS ( EGLSurfaceType )

◆ isNoSurfaceHandle()

bool kanzi::isNoSurfaceHandle ( const ::EGLSurface eglSurfaceHandle)
noexcept

Tests if a given EGL surface handle is a no surface.

Parameters
eglSurfaceHandleEGL surface handle to test.
Returns
True if given handle is a no surface, false if not.

◆ isNoSurface() [2/2]

bool kanzi::isNoSurface ( const EGLWindowSurface & eglSurface)
noexcept

Tests if a given EGL surface is a no surface.

Parameters
eglSurfaceEGL surface to test.
Returns
True if given surface is a no surface, false if not.

◆ isNativeWindowSurfaceConfigSupported()

bool kanzi::isNativeWindowSurfaceConfigSupported ( const EGLDisplay & eglDisplay,
EGLNativeWindowType eglNativeWindow,
const EGLConfig & eglConfig )
noexcept

Tests if a given EGL config is a valid window surface configuration.

Parameters
eglDisplayEGL display connection.
eglNativeWindowWindow to attach test surface to.
eglConfigEGL config to test.
Returns
True if given config is a valid surface configuration, false if not.

◆ findEGLContextClientVersion() [1/2]

KZ_NO_DISCARD optional< EGLContextClientVersion > kanzi::findEGLContextClientVersion ( const EGLDisplay & eglDisplay,
const span< ::EGLConfig > eglConfigs,
const EGLContextClientSelection selection )
noexcept

Returns the correct EGL context client version based on EGLContextClientSelection.

Parameters
eglDisplayEGL display.
eglConfigsA collection of EGL configurations.
selectionThe selection rule to use.
Return values
nulloptUnspecified version was selected.
Returns
The correct EGL context client version to use.
Since
Kanzi 3.9.10

◆ findEGLContextClientVersion() [2/2]

KZ_NO_DISCARD optional< EGLContextClientVersion > kanzi::findEGLContextClientVersion ( const EGLDisplay & eglDisplay,
const ::EGLConfig eglConfig,
const EGLContextClientSelection selection )
noexcept

Returns the correct EGL context client version based on EGLContextClientSelection.

Parameters
eglDisplayEGL display.
eglConfigThe EGL configuration to use.
selectionThe selection rule to use.
Return values
nulloptUnspecified version was selected.
Returns
The correct EGL context client version to use.
Since
Kanzi 3.9.10

◆ getCompressedGLFormat()

int kanzi::getCompressedGLFormat ( GraphicsFormat format)

Returns the GL API internal format enumeration of the kanzi::Format.

◆ calculateOrdinaryGLTargetTransformationMatrix()

KZ_NO_DISCARD Matrix4x4 kanzi::calculateOrdinaryGLTargetTransformationMatrix ( unsigned int width,
unsigned int height )
noexcept

Calculates the ordinary target transformation matrix for GLGraphicsOutput.

An ordinary target transformation will preserve the graphics element locations during target coordinate transformation.

Parameters
widthLayout area width in pixels. Must be positive.
heightLayout area height in pixels. Must be positive.
Returns
Ordinary target transformation matrix.
See also
GLGraphicsOutput::getTargetTransformation().

◆ acquireUniformLocation()

int kanzi::acquireUniformLocation ( Material & material,
string_view name )

Acquire uniform location from a material.

Parameters
materialMaterial to query.
nameUniform name.
Returns
Uniform location or -1 if invalid.
Since
Kanzi 3.9.1 changed to use KANZI_COREUI_API.

◆ getUniformElementCount()

unsigned int kanzi::getUniformElementCount ( Material & material,
string_view name )

Get uniform element count from a material.

Parameters
materialMaterial to query.
nameUniform name.
Returns
Uniform element count or 0 if invalid.
Since
Kanzi 3.9.1 changed to use KANZI_COREUI_API.

◆ acquireBlendModeRenderValue() [1/2]

optional< int > kanzi::acquireBlendModeRenderValue ( AbstractPropertyType propertyType,
Node * node,
PropertyObject * object,
Material & material )

Acquires the blend mode value.

Parameters
propertyTypeBlend mode property type to access.
nodeNode to read from.
objectProperty object to read from.
materialMaterial being used for rendering.
Returns
Optional blend mode, if set anywhere in the chain.
Since
Kanzi 3.9.1

◆ acquireBlendModeRenderValue() [2/2]

optional< int > kanzi::acquireBlendModeRenderValue ( AbstractPropertyType propertyType,
Node * node,
Brush & brush,
Material & material )

Specialized acquire of blend mode value.

Parameters
propertyTypeBlend mode property type to access.
nodeNode to read from.
brushBrush to read from.
materialMaterial being used for rendering.
Returns
Optional blend mode, if set anywhere in the chain.
Since
Kanzi 3.9.1

◆ updateRenderValueOverride() [1/10]

template<typename T >
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< T > & value )

Type-specific render value update to GPU.

Parameters
rendererRenderer to use.
valueRender value.

◆ updateRenderValueOverride() [2/10]

template<>
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< bool > & value )

updateRenderValueOverride() specialization.

◆ updateRenderValueOverride() [3/10]

template<>
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< int > & value )

updateRenderValueOverride() specialization.

◆ updateRenderValueOverride() [4/10]

template<>
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< float > & value )

updateRenderValueOverride() specialization.

◆ updateRenderValueOverride() [5/10]

template<>
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< ColorRGBA > & value )

updateRenderValueOverride() specialization.

◆ updateRenderValueOverride() [6/10]

template<>
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< Vector2 > & value )

updateRenderValueOverride() specialization.

◆ updateRenderValueOverride() [7/10]

template<>
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< Vector3 > & value )

updateRenderValueOverride() specialization.

◆ updateRenderValueOverride() [8/10]

template<>
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< Vector4 > & value )

updateRenderValueOverride() specialization.

◆ updateRenderValueOverride() [9/10]

template<>
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< Matrix3x3 > & value )

updateRenderValueOverride() specialization.

◆ updateRenderValueOverride() [10/10]

template<>
void kanzi::updateRenderValueOverride ( Renderer & renderer,
const GlRenderValue< Matrix4x4 > & value )

updateRenderValueOverride() specialization.

◆ updateRenderValue() [1/3]

template<typename T >
void kanzi::updateRenderValue ( Renderer & renderer,
GlRenderValue< T > & value )

Update render value container to GPU.

Parameters
rendererRenderer to use.
valueRender value.

◆ updateRenderValue() [2/3]

template<typename T >
bool kanzi::updateRenderValue ( Renderer & renderer,
GlRenderValue< T > & value,
unsigned int textureUnit )

Update render value container to the GPU.

This method uses given texture unit. If the render value was in any way invalid, the texture is unbound for given texture unit. Only specialized for classes for which texture unit makes sense.

Parameters
rendererRenderer to use.
valueRender value.
textureUnitTexture unit to use.
Returns
True if a valid texture was bound.

◆ updateRenderValue() [3/3]

template<>
bool kanzi::updateRenderValue ( Renderer & renderer,
GlRenderValue< TextureSharedPtr > & value,
unsigned int textureUnit )

◆ SwizzleMaskARGBToRGBA()

◆ SwizzleMaskRGBToLuminanceAlpha()

◆ SwizzleMaskLuminanceToRGBA()

constexpr TextureSwizzleMask kanzi::SwizzleMaskLuminanceToRGBA ( TextureSwizzleMask::ColorComponent::Alpha )
constexpr

Masks all color channels with alpha.

◆ swap() [7/12]

void kanzi::swap ( Mesh::Skeleton & skeleton1,
Mesh::Skeleton & skeleton2 )
inline

◆ swap() [8/12]

void kanzi::swap ( Mesh::Cluster & cluster1,
Mesh::Cluster & cluster2 )
inline

◆ swap() [9/12]

void kanzi::swap ( Mesh & mesh1,
Mesh & mesh2 )
inline

◆ swap() [10/12]

void kanzi::swap ( Renderbuffer & buffer1,
Renderbuffer & buffer2 )
inline

◆ getAttributeDimension()

unsigned int kanzi::getAttributeDimension ( VertexAttribute::Semantic attribute)

Gets the number of elements for a vertex attribute semantic.

Parameters
attributeAttribute semantic.
Returns
Number of elements for the attribute or 0 if undefined.

◆ captureCurrentFramebufferToImage()

BitmapImageUniquePtr kanzi::captureCurrentFramebufferToImage ( unsigned int width,
unsigned int height,
GraphicsFormat format )

Capture the current framebuffer to an image.

Parameters
widthCapture area width.
heightCapture area height.
formatGraphics format to capture with.
Returns
Captured framebuffer as image.

◆ captureScreenToImage()

BitmapImageUniquePtr kanzi::captureScreenToImage ( Renderer & renderer,
unsigned int width,
unsigned int height,
GraphicsFormat format )

Capture the screen (default framebuffer) to an image.

Parameters
rendererRenderer whose framebuffer Kanzi captures.
widthCapture area width.
heightCapture area height.
formatGraphics format to capture with.
Returns
Captured screen as image.

◆ swap() [11/12]

void kanzi::swap ( ShaderProgram & shader1,
ShaderProgram & shader2 )
inline

◆ toFixedUniform()

optional< ShaderProgram::FixedUniform > kanzi::toFixedUniform ( string_view uniformName)

Gets FixedUniform from given string.

Parameters
uniformNameName of fixed uniform.
Returns
FixedUniform corresponding to given name, or nullopt if there is no match.

◆ getFixedUniformFunction() [1/2]

ShaderProgram::FixedUniformFunction kanzi::getFixedUniformFunction ( string_view renderValueName,
ShaderProgram::UniformTransformation transformation )

Gets a matching fixed uniform function for a fixed uniform.

Parameters
renderValueNameName of the render value.
transformationTransformation to apply for the fixed uniform.
Returns
Function pointer or nullptr if there is no corresponding fixed uniform function.

◆ getFixedUniformFunction() [2/2]

ShaderProgram::FixedUniformFunction kanzi::getFixedUniformFunction ( string_view renderValueName)

Gets a matching fixed uniform function for a fixed uniform.

Transformation is set to pass-through.

Parameters
renderValueNameName of the render value.
Returns
Function pointer or nullptr if there is no corresponding fixed uniform function.

◆ getFixedUniformFunctionInfo()

const ShaderProgram::FixedUniformFunctionInfo & kanzi::getFixedUniformFunctionInfo ( ShaderProgram::FixedUniform uniform)

Gets a matching fixed uniform function for a fixed uniform.

Parameters
uniformFixedUniform enumeration value.
Returns
Structure with function pointer and type. If there is no corresponding fixed uniform function, the function pointer is nullptr.
Since
Kanzi 3.9.6

◆ swap() [12/12]

void kanzi::swap ( ShaderProgram::CreateInfo & createInfo1,
ShaderProgram::CreateInfo & createInfo2 )
inline

◆ loadShaderProgramCreateInfo()

ShaderProgram::CreateInfo kanzi::loadShaderProgramCreateInfo ( KzbFile & kzbFile,
ReadOnlyMemoryFile & file,
KzbMemoryParser & parser,
string_view name )

Loads a shader program create info from a kzb file.

Parameters
kzbFileThe kzb file.
fileThe file where to load.
parserMemory parser to use.
nameName of the shader resource.
Returns
Struct that contains parameters to create a ShaderProgram.

◆ getVerboseDescription() [2/2]

FixedString kanzi::getVerboseDescription ( ShaderProgram::CreateInfo::Status status)

Returns human readable description for ShaderProgram CreateInfo status.

Parameters
statusStatus
Returns
Human readable description for status.

◆ createDefaultRenderValueBinding()

optional< BindingLoadInfo > kanzi::createDefaultRenderValueBinding ( Domain * domain,
optional< AbstractPropertyType > propertyType,
string_view renderValueName,
PropertyDataType dataType,
unsigned arraySize,
ShaderProgram::UniformTransformation transformation )

Creates a default binding for a given render value.

Used to create the typical bindings upon loading as opposed to loading specific bindings for the same render values from a file.

Parameters
domainDomain.
propertyTypeProperty type to use if no render pass property is used.
renderValueNameRender value name to create for.
dataTypeData type of the uniform.
arraySizeSize of the uniform array for the value in question.
transformationTransformation applied to the property in the binding.
Returns
Binding created or nullopt.

◆ prepend() [1/2]

EventQueue::Container::iterator kanzi::prepend ( EventQueue & queue,
EventQueue::Container::iterator position,
UniqueEventPtr && event )

Inserts an event into a queue before the given position.

Parameters
queueThe event queue into which to move the container content.
positionThe iterator of the event queue before which to insert the content.
eventThe event to insert into the event queue.
Returns
The updated iterator pointing to the position given as argument.
Since
Kanzi 3.9.0

◆ prepend() [2/2]

EventQueue::Container::iterator kanzi::prepend ( EventQueue & queue,
EventQueue::Container::iterator position,
EventQueue::Container & container )

Moves a container content into a queue before the given position.

Parameters
queueThe event queue into which to move the container content.
positionThe iterator of the event queue before which to insert the content.
containerThe container to insert into the event queue.
Returns
The updated iterator pointing to the position given as argument.
Since
Kanzi 3.9.0

◆ prependAndAdvance() [1/2]

EventQueue::Container::iterator kanzi::prependAndAdvance ( EventQueue & queue,
EventQueue::Container::iterator position,
UniqueEventPtr && event )

Inserts an event content into a queue before the given position.

Parameters
queueThe event queue into which to move the container content.
positionThe iterator of the event queue before which to insert the content.
eventThe event to insert into the event queue.
Returns
The iterator pointing to the first event that is after the position of the inserted event. If the position of the inserted event is the end iterator, returns the updated end iterator value.
Since
Kanzi 3.9.0

◆ prependAndAdvance() [2/2]

EventQueue::Container::iterator kanzi::prependAndAdvance ( EventQueue & queue,
EventQueue::Container::iterator position,
EventQueue::Container & container )

Moves a container content into a queue before the given position.

Parameters
queueThe event queue into which to move the container content.
positionThe iterator of the event queue before which to insert the content.
containerThe container to insert into the event queue.
Returns
The iterator pointing to the first event that is after the position of the inserted container content. If the position of the inserted container content is the end iterator, returns the updated end iterator value.
Since
Kanzi 3.9.0

◆ addKeyEvent()

void kanzi::addKeyEvent ( EventQueue & queue,
size_t rawKeyCode,
LogicalKey key,
KeyModifier modifiers,
KeyState state )

Adds a KeyEvent with multiple key modifiers to the queue.

Parameters
queueThe queue to which to push the event.
rawKeyCodeThe raw key code. This is specific to the operating system. If unknown, set to 0.
keyThe LogicalKey code translated from the rawKeyCode. If the raw key code does not translate to a logical key, set to LogicalKey::Unknown.
modifiersKey modifier flags, a combination of KeyModifier values. If the key operating system modifier does not translate to any Kanzi KeyModifier flag, set to KeyModifier::Undefined.
stateThe key state. See KeyState.
See also
KeyEvent
Since
Kanzi 3.8.0 key modifiers argument is of KeyModifier type.

◆ addKeyRepeatEvent()

void kanzi::addKeyRepeatEvent ( EventQueue & queue,
size_t rawKeyCode,
LogicalKey key,
KeyModifier modifiers,
size_t repeatCount )

Adds to the queue a KeyEvent with multiple key modifiers, KeyState::Pressed state, and key-press repeatCount.

Parameters
queueThe queue to which to push the event.
rawKeyCodeThe raw key code. This is specific to the operating system. If unknown, set to 0.
keyThe LogicalKey code translated from the rawKeyCode. If the raw key code does not translate to a logical key, set to LogicalKey::Unknown.
modifiersModifier key flags, a combination of KeyModifier values. If the key operating system modifier does not translate to any Kanzi KeyModifier flag, set to KeyModifier::Undefined.
repeatCountThe 1-base key-press repetition count.
See also
KeyEvent
Since
Kanzi 3.9.0

◆ addPointerEvent()

void kanzi::addPointerEvent ( EventQueue & queue,
int x,
int y,
PointerButton buttons,
PointerState state,
int scroll = 0 )

Adds a PointerEvent to the queue.

Parameters
queueThe queue to push the event in.
xThe x axis coordinate of the pointer.
yThe y axis coordinate of the pointer.
buttonsThe buttons of the event. A combination of PointerButton values.
stateThe state of the pointer device.
scrollThe scroll amount, applied on mouse wheel events. The value is valid when the state is set to PointerState::Scrolled.
See also
PointerEvent
Since
Kanzi 3.8.0 the buttons argument is of type PointerButton.

◆ addSinglePointTouchEvent()

void kanzi::addSinglePointTouchEvent ( EventQueue & queue,
TouchState state,
size_t id,
TouchPointState pointState,
float x,
float y,
float pressure = 1.0f,
float radius = 1.0f )

Adds a TouchEvent with one touch point to the queue.

Parameters
queueThe queue to push the event in.
stateThe state of the touch.
idThe touch point identifier.
pointStateThe state of the point.
xThe x axis coordinate of the touch point.
yThe y axis coordinate of the touch point.
pressureThe touch pressure.
radiusThe touch radius.
See also
TouchEvent

◆ addTouchEvent()

void kanzi::addTouchEvent ( EventQueue & queue,
TouchState state,
const list< TouchEvent::TouchPoint > & points )

Adds a TouchEvent with multiple touch points to the queue.

Parameters
queueThe queue to push the event in.
stateThe state of the touch.
pointsThe touch points.
See also
TouchEvent
Since
Kanzi 3.9.4

◆ addWindowResizedEvent()

void kanzi::addWindowResizedEvent ( EventQueue & queue,
NativeWindowHandle target,
unsigned int width,
unsigned int height )

Adds a WindowResizedEvent to the queue.

Parameters
queueThe queue to which to push the event.
targetThe window that you want to resize.
widthThe width of the window.
heightThe height of the window.

◆ addWindowResizeRequestEvent()

void kanzi::addWindowResizeRequestEvent ( EventQueue & queue,
NativeWindowHandle target,
unsigned int width,
unsigned int height )

Adds a WindowResizeRequestEvent to the queue.

Parameters
queueThe queue to which to push the event.
targetThe window that you want to resize.
widthThe requested width of the window.
heightThe requested height of the window.

◆ addWindowFocusLostEvent()

void kanzi::addWindowFocusLostEvent ( EventQueue & queue,
NativeWindowHandle target )

Adds a WindowEvent with InputEvent::WindowFocusLost type to the queue.

Parameters
queueThe queue to which to push the event.
targetThe window that lost the focus.

◆ addWindowFocusGainedEvent()

void kanzi::addWindowFocusGainedEvent ( EventQueue & queue,
NativeWindowHandle target )

Adds a WindowEvent with InputEvent::WindowFocusGained type to the queue.

Parameters
queueThe queue to which to push the event.
targetThe window that gained the focus.

◆ addWindowHiddenEvent()

void kanzi::addWindowHiddenEvent ( EventQueue & queue,
NativeWindowHandle target )

Adds a WindowEvent with InputEvent::WindowHidden type to the queue.

Parameters
queueThe queue to which to push the event.
targetThe hidden window.

◆ addWindowResourceLostEvent()

void kanzi::addWindowResourceLostEvent ( EventQueue & queue,
NativeWindowHandle target )

Adds a WindowEvent with InputEvent::WindowResourceLost type to the queue.

Parameters
queueThe queue to which to push the event.
targetThe window that lost the resources.

◆ addWindowOrientationChangedEvent()

void kanzi::addWindowOrientationChangedEvent ( EventQueue & queue,
NativeWindowHandle target,
WindowOrientation orientation )

Adds an OrientationChangedEvent to the queue.

Parameters
queueThe queue to which to push the event.
targetThe window to which to apply the orientation change.
orientationThe orientation to apply to the window.

◆ addWindowRedrawRequestEvent()

void kanzi::addWindowRedrawRequestEvent ( EventQueue & queue,
NativeWindowHandle target )

Adds a WindowRedrawRequestEvent to the queue.

Parameters
queueThe queue to which to push the event.
targetThe window that you want to redraw itself.

◆ addWindowPlacementRequestEvent()

void kanzi::addWindowPlacementRequestEvent ( EventQueue & queue,
NativeWindowHandle target )

Adds a WindowPlacementRequest to the queue.

Parameters
queueThe queue to which to push the event.
targetThe window for which to notify a new placement.
Since
Kanzi 3.9.7

◆ addWindowClosedEvent()

void kanzi::addWindowClosedEvent ( EventQueue & queue,
NativeWindowHandle target )

Adds a WindowEvent with InputEvent::WindowClosed type to the queue.

Parameters
queueThe queue to which to push the event.
targetThe window that has been closed.

◆ addApplicationPausedEvent()

void kanzi::addApplicationPausedEvent ( EventQueue & queue)

Adds an InputEvent with InputEvent::ApplicationPaused type to the queue.

Parameters
queueThe queue to which to push the event.

◆ addApplicationSleepEvent()

void kanzi::addApplicationSleepEvent ( EventQueue & queue)

Adds an InputEvent with InputEvent::ApplicationSleep type to the queue.

Parameters
queueThe queue to which to push the event.

◆ addApplicationWakeupEvent()

void kanzi::addApplicationWakeupEvent ( EventQueue & queue)

Adds an InputEvent with InputEvent::ApplicationWakeup type to the queue.

Parameters
queueThe queue to which to push the event.

◆ addToggleHudDebugEvent()

void kanzi::addToggleHudDebugEvent ( EventQueue & queue)

Adds an InputEvent with InputEvent::DebugToggleHud type to the queue.

Parameters
queueThe queue to which to push the event.

◆ addSetHudDebugEvent()

void kanzi::addSetHudDebugEvent ( EventQueue & queue,
bool onOff )

Adds a HudDebugEvent to the queue.

Parameters
queueThe queue to which to push the event.
onOfftrue to toggle on the head-up display debugging, false to toggle it off.

◆ isKeyModifier()

bool kanzi::isKeyModifier ( LogicalKey key)

Checks whether the key of the event is a modifier key.

Returns
If the key is a modifier key, true, otherwise false.
Since
Kanzi 3.9.4

◆ operator==() [1/13]

Equality operator for KeyEvents.

Since
Kanzi 3.9.0

◆ operator!=() [1/13]

Inequality operator for KeyEvents.

Since
Kanzi 3.9.0

◆ pointerToTouchEvent()

optional< TouchEvent > kanzi::pointerToTouchEvent ( const PointerEvent & pointer)

Converts a pointer event to an equivalent touch event.

Parameters
pointerThe pointer event to convert.
Return values
nulloptPointer event was a hover event.
Returns
The touch event converted from the pointer event.
Since
Kanzi 3.7.0

◆ KZ_ENABLE_BITMASK_OPERATORS() [4/4]

kanzi::KZ_ENABLE_BITMASK_OPERATORS ( QnxChannelIDFlags )

◆ assignFieldValue()

void kanzi::assignFieldValue ( TargetType & value,
PropertyField field,
FieldType fieldValue )

Free function for setting a field of a value.

Called internally by Variant functions, but may be used externally if necessary.

Parameters
valueValue the field is being set.
fieldThe field to set.
fieldValueNew field value.

◆ assignFieldValue< ColorRGBA, float >()

template<>
void kanzi::assignFieldValue< ColorRGBA, float > ( ColorRGBA & value,
PropertyField field,
float fieldValue )

Specialization of assignFieldValue;.

◆ assignFieldValue< Vector2, float >()

template<>
void kanzi::assignFieldValue< Vector2, float > ( Vector2 & value,
PropertyField field,
float fieldValue )

Specialization of assignFieldValue;.

◆ assignFieldValue< Vector3, float >()

template<>
void kanzi::assignFieldValue< Vector3, float > ( Vector3 & value,
PropertyField field,
float fieldValue )

Specialization of assignFieldValue;.

◆ assignFieldValue< Vector4, float >()

template<>
void kanzi::assignFieldValue< Vector4, float > ( Vector4 & value,
PropertyField field,
float fieldValue )

Specialization of assignFieldValue;.

◆ assignFieldValue< Matrix3x3, float >()

template<>
void kanzi::assignFieldValue< Matrix3x3, float > ( Matrix3x3 & value,
PropertyField field,
float fieldValue )

Specialization of assignFieldValue;.

◆ assignFieldValue< Matrix4x4, float >()

template<>
void kanzi::assignFieldValue< Matrix4x4, float > ( Matrix4x4 & value,
PropertyField field,
float fieldValue )

Specialization of assignFieldValue;.

◆ assignFieldValue< SRTValue2D, float >()

template<>
void kanzi::assignFieldValue< SRTValue2D, float > ( SRTValue2D & value,
PropertyField field,
float fieldValue )

Specialization of assignFieldValue;.

◆ assignFieldValue< SRTValue3D, float >()

template<>
void kanzi::assignFieldValue< SRTValue3D, float > ( SRTValue3D & value,
PropertyField field,
float fieldValue )

Specialization of assignFieldValue;.

◆ assignFieldValue< SRTValue3D, Quaternion >()

template<>
void kanzi::assignFieldValue< SRTValue3D, Quaternion > ( SRTValue3D & value,
PropertyField field,
Quaternion fieldValue )

Specialization of assignFieldValue;.

◆ retrieveFieldValue()

template<typename T >
float kanzi::retrieveFieldValue ( const T & value,
PropertyField field )

Free function for retrieving a value of a field.

Called internally by Variant functions, but may be used externally if necessary.

Parameters
valueValue to retrieve from.
fieldField to retrieve.
Returns
Value of field.

◆ retrieveFieldValue< ColorRGBA >()

Specialization of retrieveFieldValue.

◆ retrieveFieldValue< Vector2 >()

Specialization of retrieveFieldValue.

◆ retrieveFieldValue< Vector3 >()

Specialization of retrieveFieldValue.

◆ retrieveFieldValue< Vector4 >()

Specialization of retrieveFieldValue.

◆ retrieveFieldValue< Matrix3x3 >()

Specialization of retrieveFieldValue.

◆ retrieveFieldValue< Matrix4x4 >()

Specialization of retrieveFieldValue.

◆ retrieveFieldValue< SRTValue2D >()

Specialization of retrieveFieldValue.

◆ retrieveFieldValue< SRTValue3D >()

Specialization of retrieveFieldValue.

◆ variantCast() [1/2]

Variant kanzi::variantCast ( const Variant & value,
PropertyDataType targetDataType )

Casts variant to another data type.

Parameters
valueValue to cast.
targetDataTypeData type to which to cast the value.
Returns
Variant of another type.

◆ variantCast() [2/2]

template<typename T >
Variant kanzi::variantCast ( const Variant & value)

Casts variant to another data type.

This is a templated version that avoids switch/case.

Parameters
valueValue to cast.
Returns
Variant of another type.

◆ variantCast< float >()

template<>
Variant kanzi::variantCast< float > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< int >()

template<>
Variant kanzi::variantCast< int > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< bool >()

template<>
Variant kanzi::variantCast< bool > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< ColorRGBA >()

template<>
Variant kanzi::variantCast< ColorRGBA > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< Vector2 >()

template<>
Variant kanzi::variantCast< Vector2 > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< Vector3 >()

template<>
Variant kanzi::variantCast< Vector3 > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< Vector4 >()

template<>
Variant kanzi::variantCast< Vector4 > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< Matrix3x3 >()

template<>
Variant kanzi::variantCast< Matrix3x3 > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< Matrix4x4 >()

template<>
Variant kanzi::variantCast< Matrix4x4 > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< SRTValue2D >()

Specialization of typed variantCast.

◆ variantCast< SRTValue3D >()

Specialization of typed variantCast.

◆ variantCast< string >()

template<>
Variant kanzi::variantCast< string > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< ResourceSharedPtr >()

Specialization of typed variantCast.

◆ variantCast< void * >()

template<>
Variant kanzi::variantCast< void * > ( const Variant & value)

Specialization of typed variantCast.

◆ variantCast< AbstractRangeSharedPtr >()

Specialization of typed variantCast.

◆ loadPrefabAsync()

void kanzi::loadPrefabAsync ( const Node & node,
ResourceID prefabResourceId,
ResourceManager::AsyncAcquireFinishedCallback callback )

Acquires prefab and required nested resources recursively.

Callback is executed when all required resources have been acquired.

Parameters
nodeNode where prefab will be instantiated, and the node to resolve from.
prefabResourceIdResource ID of the prefab to load.
callbackCallback to execute upon completion.

◆ collectResourceUrls() [3/8]

void kanzi::collectResourceUrls ( const PrefabTemplate & prefabTemplate,
const Node & node,
ResourceManager::UrlContainer & urls )

Collects URLs from all resource properties that are used by the nodes in a prefab template.

If the nodes contain nested prefab templates (i.e. prefab placeholders) or node components, collects URLs also from those. For resources set with resource IDs, resolves their URLs by looking up in the prefab and node tree, and then collects them too.

Parameters
prefabTemplateThe prefab template instance.
nodeNode where the template will be instantiated.
urlsA container where the collected URLs will be added.

◆ collectResourceUrlsFromStateManagersAndRenderPassPrefabs() [1/2]

void kanzi::collectResourceUrlsFromStateManagersAndRenderPassPrefabs ( const PrefabTemplate & prefabTemplate,
const Node & node,
ResourceManager::UrlContainer & urls )

Looks up resource properties of type StateManager or RenderPassPrefab in the nodes of a prefab template.

Acquires them, and then collects URLs from all their resource properties. Typically called after acquiring the collected urls of a prefab template, for a deeper collection. For resources set with resource IDs, resolves their URLs by looking up in the prefab and node tree, and then collects them too.

Parameters
prefabTemplateThe prefab template instance.
nodeNode where the template will be instantiated.
urlsA container where the collected URLs will be added.

◆ collectResourceUrls() [4/8]

void kanzi::collectResourceUrls ( const PrefabTemplate & prefabTemplate,
ResourceManager::UrlContainer & urls )

Collects URLs from all resource properties that are used by the nodes in a prefab template.

If the nodes contain nested prefab templates (i.e. prefab placeholders) or node components, collects URLs also from those. For resources set with resource IDs, resolves their URLs by looking up in the prefab tree, and then collects them too.

Parameters
prefabTemplateThe prefab template.
urlsA container where the collected URLs will be added.

◆ collectResourceUrls() [5/8]

void kanzi::collectResourceUrls ( const PrefabTemplateNode & prefabTemplateNode,
ResourceManager::UrlContainer & urls )

Collects URLs from all resource properties that are used by a prefab template node and its children.

If the nodes contain nested prefab templates (i.e. prefab placeholders) or node components, collects URLs also from those. For resources set with resource IDs, resolves their URLs by looking up in the prefab tree, and then collects them too.

Parameters
prefabTemplateNodeThe prefab template node.
urlsA container where the collected URLs will be added.

◆ collectResourceUrlsFromStateManagersAndRenderPassPrefabs() [2/2]

void kanzi::collectResourceUrlsFromStateManagersAndRenderPassPrefabs ( const PrefabTemplate & prefabTemplate,
ResourceManager::UrlContainer & urls )

Looks up resource properties of type StateManager or RenderPassPrefab in the nodes of a prefab template.

Acquires them, and then collects URLs from all their resource properties. Typically called after acquiring the collected urls of a prefab template, for a deeper collection. For resources set with resource IDs, resolves their URLs by looking up in the prefab tree, and then collects them too.

Parameters
prefabTemplateThe prefab template instance.
urlsA container where the collected URLs will be added.

◆ collectResourceUrls() [6/8]

void kanzi::collectResourceUrls ( const ResourceDictionary & resourceDictionary,
ResourceManager::UrlContainer & urls )

Collects the URLs from a resource dictionary.

If the resource dictionary has nested dictionary, collects URLs also from those.

Parameters
resourceDictionaryThe resource dictionary.
urlsA container where the collected URLs will be added.

◆ collectResourceUrls() [7/8]

void kanzi::collectResourceUrls ( ResourceManager * resourceManager,
string_view hostname,
ResourceManager::UrlContainer & urls )

Collect resource urls from a named file.

Parameters
resourceManagerResource manager to collect from.
hostnameKZB hostname part of the URL.
urlsA container where the collected URLs will be added.

◆ collectResourceUrlsFromPrefabTemplateUrl() [1/2]

void kanzi::collectResourceUrlsFromPrefabTemplateUrl ( ResourceManager * resourceManager,
string_view prefabTemplateUrl,
const Node & node,
ResourceManager::UrlContainer & urls )

Collects URLs from all resource properties that are used by the nodes in a prefab template.

If the nodes contain nested prefab templates (i.e. prefab placeholders) or node components, collects URLs also from those. For resources set with resource IDs, resolves their URLs by looking up in the prefab and node tree, and then collects them too.

Parameters
resourceManagerThe resource manager.
prefabTemplateUrlThe URL of a prefab template. For example "kzb://asynchronous_loading/Prefabs/Prefab that uses many textures".
nodeNode where the template will be instantiated.
urlsA container where the collected URLs will be added.

◆ collectResourceUrlsFromPrefabTemplateUrl() [2/2]

void kanzi::collectResourceUrlsFromPrefabTemplateUrl ( ResourceManager * resourceManager,
string_view prefabTemplateUrl,
ResourceManager::UrlContainer & urls )

Collects URLs from all resource properties that are used by the nodes in a prefab template.

If the nodes contain nested prefab templates (i.e. prefab placeholders) or node components, collects URLs also from those. For resources set with resource IDs, resolves their URLs by looking up in the prefab tree, and then collects them too.

Parameters
resourceManagerThe resource manager.
prefabTemplateUrlThe URL of a prefab template. For example "kzb://asynchronous_loading/Prefabs/Prefab that uses many textures".
urlsA container where the collected URLs will be added.

◆ tryCollectResourceUrlsFromPrefabTemplateUrl() [1/2]

void kanzi::tryCollectResourceUrlsFromPrefabTemplateUrl ( ResourceManager * resourceManager,
string_view prefabTemplateUrl,
const Node & node,
ResourceManager::UrlContainer & urls )

Collects URLs from all resource properties that are used by the nodes in a prefab template, like collectResourceUrlsFromPrefabTemplateUrl, but does not throw an exception if the prefab template is not found.

See also
collectResourceUrlsFromPrefabTemplateUrl Collects URLs from all resource properties that are used by the nodes in a prefab template. If the nodes contain nested prefab templates (i.e. prefab placeholders) or node components, collects URLs also from those. For resources set with resource IDs, resolves their URLs by looking up in the prefab and node tree, and then collects them too.
Parameters
resourceManagerThe resource manager.
prefabTemplateUrlThe URL of a prefab template. For example "kzb://asynchronous_loading/Prefabs/Prefab that uses many textures".
nodeNode where the template will be instantiated.
urlsA container where the collected URLs will be added.
Since
Kanzi 3.9.0

◆ tryCollectResourceUrlsFromPrefabTemplateUrl() [2/2]

void kanzi::tryCollectResourceUrlsFromPrefabTemplateUrl ( ResourceManager * resourceManager,
string_view prefabTemplateUrl,
ResourceManager::UrlContainer & urls )

Collects URLs from all resource properties that are used by the nodes in a prefab template, like collectResourceUrlsFromPrefabTemplateUrl, but does not throw an exception if the prefab template is not found.

See also
collectResourceUrlsFromPrefabTemplateUrl If the nodes contain nested prefab templates (i.e. prefab placeholders) or node components, collects URLs also from those. For resources set with resource IDs, resolves their URLs by looking up in the prefab tree, and then collects them too.
Parameters
resourceManagerThe resource manager.
prefabTemplateUrlThe URL of a prefab template. For example "kzb://asynchronous_loading/Prefabs/Prefab that uses many textures".
urlsA container where the collected URLs will be added.
Since
Kanzi 3.9.0

◆ collectResourceUrlsFromPrefabTemplateNodeResourceDictionaryUrls()

KZ_DEPRECATED void kanzi::collectResourceUrlsFromPrefabTemplateNodeResourceDictionaryUrls ( ResourceManager * resourceManager,
string_view prefabTemplateNodeUrls,
ResourceManager::UrlContainer & urls )

Collects the URLs of resources from the resource dictionaries of the prefab templates you specify.

Parameters
resourceManagerThe resource manager.
prefabTemplateNodeUrlsSemicolon separated list of urls to prefab template nodes. For example "kzb://preloading_test/Prefabs/Empty Node 2D/Empty Node 2D;kzb://preloading_text/Prefabs/Stack Layout 2D/Stack Layout 2D".
urlsA container where the collected URLs will be added.
Deprecated
Part of legacy KZB loading. The new KZB format does not store prefab template nodes separately.

◆ collectResourceUrls() [8/8]

void kanzi::collectResourceUrls ( ResourceManager * resourceManager,
ResourceManager::UrlContainer & urls )

Collects the URLs of all resources from all the binary directories that have been added to the resource manager.

This includes resources you did not include in the resource dictionaries of specific nodes.

Parameters
resourceManagerThe resource manager.
urlsA container where the collected URLs will be added.

◆ registerDefaultResources()

void kanzi::registerDefaultResources ( Screen & screen)

Registers default resources in the resource manager and Screen node's dictionary.

◆ loadSplineFromKZB()

SplinePtr kanzi::loadSplineFromKZB ( KzbMemoryParser & parser)

Load a spline spline from memory parser.

Parameters
parserKzbMemoryParser that the spline data is loaded from.
Returns
Spline unique pointer.

◆ registerNodeComponentLoader()

void kanzi::registerNodeComponentLoader ( ObjectLoader & objectLoader,
const Metaclass * metaclass )

Registers node component template loader for specified node component type.

Parameters
objectLoaderObject loader where to register loading of specified node component type.
metaclassMetaclass of node component to load.

◆ registerNodeComponentLoaders()

void kanzi::registerNodeComponentLoaders ( ObjectLoader & objectLoader)

Registers node component template loaders for build-in node component types.

Parameters
objectLoaderObject loader where to register loading of node components.

◆ isRTL()

bool kanzi::isRTL ( string_view text)

Returns true if the text is right-to-left aligned, otherwise false.

◆ getUtf8Length()

size_t kanzi::getUtf8Length ( string_view text)

Returns the number of UTF-8 characters in the text.

◆ getUtf8WordBounds()

pair< size_t, size_t > kanzi::getUtf8WordBounds ( string_view text,
size_t position )

Gets the character positions at the begin and end of the word to which the character at position position belongs.

◆ getUtf8WordCount()

size_t kanzi::getUtf8WordCount ( string_view text)

Gets the number of words in a UTF-8 text string.

◆ getUtf8NextWordbreakPosition() [1/2]

size_t kanzi::getUtf8NextWordbreakPosition ( string_view text,
size_t position )

Gets the position of the next word break following the character position position.

◆ getUtf8NextWordbreakPosition() [2/2]

size_t kanzi::getUtf8NextWordbreakPosition ( string_view text,
size_t position,
size_t words )

Gets the position of the next word break following the character position position after the number of words words.

◆ getUtf8PreviousWordbreakPosition() [1/2]

size_t kanzi::getUtf8PreviousWordbreakPosition ( string_view text,
size_t position )

Gets the position of the previous word break that precedes the character position position.

◆ getUtf8PreviousWordbreakPosition() [2/2]

size_t kanzi::getUtf8PreviousWordbreakPosition ( string_view text,
size_t position,
size_t words )

Gets the position of the next word break following the character position position after the number of words words.

◆ truncateToUtf8Length()

string_view kanzi::truncateToUtf8Length ( string_view text,
size_t length )

◆ getGraphemeClusters()

vector< size_t > kanzi::getGraphemeClusters ( string_view text)

Returns the indices of the characters that start new grapheme clusters in the given text.

◆ applyPlatformMmapMode()

KZ_NO_DISCARD int kanzi::applyPlatformMmapMode ( int flags)

Apply chosen platform mmapMode strategy to mmap() flags.

Currently only QNX modified flags, but this function is provided to all systems that use mmap() for cohesion.

Parameters
flagsFlags to apply platform mmapMode to.
Returns
Flags to give to mmap().

◆ setPlatformMmapMode()

void kanzi::setPlatformMmapMode ( MmapMode mode)

Set mmap() strategy.

Parameters
modemmap() strategy to use.

◆ contains() [1/2]

template<typename T , size_t Size, typename U >
bool kanzi::contains ( const array< T, Size > & c,
const U & value )

◆ from_chars() [1/3]

from_chars_result kanzi::from_chars ( const char * first,
const char * last,
unsigned int & value,
int base = 10 )
inline

Converts a character sequence to an unsigned integer value.

This is implementation of std::from_chars that is available in C++17. According to the standard specification this function should not depend on the active locale, however this implementation is affected by the active locale.

Parameters
firstPointer to the first character in the range to be converted.
lastPointer to the first character beyond the last in range to be converted.
valueReference to the storage where the converted value is stored.
baseInteger base of the character string.
Returns
Status result of the value conversion.

◆ from_chars() [2/3]

from_chars_result kanzi::from_chars ( const char * first,
const char * last,
unsigned long & value,
int base = 10 )
inline

Converts a character sequence to an unsigned long value.

This is implementation of std::from_chars that is available in C++17. According to the standard specification this function should not depend on the active locale, however this implementation is affected by the active locale.

Parameters
firstPointer to the first character in the range to be converted.
lastPointer to the first character beyond the last in range to be converted.
valueReference to the storage where the converted value is stored.
baseInteger base of the character string.
Returns
Status result of the value conversion.

◆ from_chars() [3/3]

from_chars_result kanzi::from_chars ( const char * first,
const char * last,
unsigned long long & value,
int base = 10 )
inline

Converts a character sequence to an unsigned long long value.

This is implementation of std::from_chars that is available in C++17. According to the standard specification this function should not depend on the active locale, however this implementation is affected by the active locale.

Parameters
firstPointer to the first character in the range to be converted.
lastPointer to the first character beyond the last in range to be converted.
valueReference to the storage where the converted value is stored.
baseInteger base of the character string.
Returns
Status result of the value conversion.

◆ strtof()

float kanzi::strtof ( const char * val,
char ** end_ptr )
inline

◆ prev() [1/2]

template<class T , class D >
T kanzi::prev ( T t,
D d )

◆ prev() [2/2]

template<class T >
T kanzi::prev ( T t)

◆ begin()

template<class T >
T::iterator kanzi::begin ( T & t)

◆ end()

template<class T >
T::iterator kanzi::end ( T & t)

◆ rbegin()

template<class T >
T::reverse_iterator kanzi::rbegin ( T & t)

◆ rend()

template<class T >
T::reverse_iterator kanzi::rend ( T & t)

◆ cbegin() [1/2]

template<class T >
T::const_iterator kanzi::cbegin ( T const & t)

◆ cbegin() [2/2]

template<class T , size_t N>
const T * kanzi::cbegin ( const T(&) array[N])

◆ cend() [1/2]

template<class T >
T::const_iterator kanzi::cend ( T const & t)

◆ cend() [2/2]

template<class T , size_t N>
const T * kanzi::cend ( const T(&) array[N])

◆ crbegin()

template<class T >
T::const_reverse_iterator kanzi::crbegin ( T const & t)

◆ crend()

template<class T >
T::const_reverse_iterator kanzi::crend ( T const & t)

◆ size() [1/2]

template<class C >
constexpr auto kanzi::size ( const C & c) -> decltype(c.size())
constexpr

◆ size() [2/2]

template<class T , size_t N>
constexpr size_t kanzi::size ( const T(&)[N])
constexprnoexcept

◆ roundDown()

float kanzi::roundDown ( double num)
inline

Helper function similar to floor, but takes a double and returns a float.

Parameters
numNumber to round.
Returns
Rounded number.

◆ uround()

unsigned int kanzi::uround ( float value)
inline

Round float to unsigned integer.

Parameters
valueInput value to round.
Returns
Value rounded to closest unsigned integer.

◆ operator==() [2/13]

template<typename T >
bool kanzi::operator== ( const shared_ptr< T > & v,
nullptr_t  )

◆ operator==() [3/13]

template<typename T >
bool kanzi::operator== ( nullptr_t ,
const shared_ptr< T > & v )

◆ operator!=() [2/13]

template<typename T >
bool kanzi::operator!= ( const shared_ptr< T > & v,
nullptr_t  )

◆ operator!=() [3/13]

template<typename T >
bool kanzi::operator!= ( nullptr_t ,
const shared_ptr< T > & v )

◆ operator==() [4/13]

template<typename T >
bool kanzi::operator== ( const unique_ptr< T > & v,
nullptr_t  )

◆ operator==() [5/13]

template<typename T >
bool kanzi::operator== ( nullptr_t ,
const unique_ptr< T > & v )

◆ operator!=() [4/13]

template<typename T >
bool kanzi::operator!= ( const unique_ptr< T > & v,
nullptr_t  )

◆ operator!=() [5/13]

template<typename T >
bool kanzi::operator!= ( nullptr_t ,
const unique_ptr< T > & v )

◆ make_polymorphic_shared_ptr()

template<typename TBase , typename T >
shared_ptr< T > kanzi::make_polymorphic_shared_ptr ( T * p)

◆ to_string() [2/12]

string kanzi::to_string ( int value)
inline

◆ to_string() [3/12]

string kanzi::to_string ( long value)
inline

◆ to_string() [4/12]

string kanzi::to_string ( long long value)
inline

◆ to_string() [5/12]

string kanzi::to_string ( unsigned int value)
inline

◆ to_string() [6/12]

string kanzi::to_string ( unsigned long value)
inline

◆ to_string() [7/12]

string kanzi::to_string ( unsigned long long value)
inline

◆ to_string() [8/12]

string kanzi::to_string ( float value)
inline

◆ to_string() [9/12]

string kanzi::to_string ( double value)
inline

◆ to_string() [10/12]

string kanzi::to_string ( long double value)
inline

◆ erase_if() [1/2]

template<class K , class T , class H , class P , class A , class Predicate >
void kanzi::erase_if ( unordered_map< K, T, H, P, A > & c,
Predicate pred )

◆ erase()

template<typename T , typename A , typename U >
void kanzi::erase ( vector< T, A > & c,
const U & value )

◆ erase_if() [2/2]

template<typename T , typename A , typename U >
void kanzi::erase_if ( vector< T, A > & c,
const U & predicate )

◆ unordered_erase()

template<typename T , typename A >
void kanzi::unordered_erase ( vector< T, A > & c,
typename vector< T, A >::iterator it )

Erases an entry from a vector without preserving the order of other entries.

More efficient than regular erase.

◆ contains() [2/2]

template<typename T , typename A , typename U >
bool kanzi::contains ( const vector< T, A > & c,
const U & value )

◆ logArgumentToString() [1/3]

template<>
string kanzi::logArgumentToString ( const JNIError & jniError)
inline

Used by logging system to convert legacy exception type objects to string.

See template logArgumentToString().

◆ kzThrowJNIError()

KZ_ATTRIBUTE_NO_RETURN void kanzi::kzThrowJNIError ( )

◆ kzErrorCodeToString()

kzString kanzi::kzErrorCodeToString ( kzsError code)

◆ logArgumentToString() [2/3]

template<>
string kanzi::logArgumentToString ( const LegacyError & legacyError)
inline

Used by logging system to convert legacy exception type objects to string.

See template logArgumentToString().

◆ kzThrowLegacyError()

KZ_ATTRIBUTE_NO_RETURN void kanzi::kzThrowLegacyError ( kzsError value)

◆ kzThrowLegacyErrorMessage() [1/2]

KZ_ATTRIBUTE_NO_RETURN void kanzi::kzThrowLegacyErrorMessage ( kzsError value,
kzString message )

◆ kzThrowLegacyErrorMessage() [2/2]

KZ_ATTRIBUTE_NO_RETURN void kanzi::kzThrowLegacyErrorMessage ( kzsError value,
const string & message )

◆ kzThrowLegacyErrorFormat()

KZ_ATTRIBUTE_NO_RETURN void kanzi::kzThrowLegacyErrorFormat ( kzsError value,
kzString format,
... )

◆ kzFormatVariadicLogMessage()

string kanzi::kzFormatVariadicLogMessage ( kzString format,
... )

◆ kzFormatVariadicLogMessageList()

string kanzi::kzFormatVariadicLogMessageList ( kzString format,
va_list arguments )

◆ readAsText()

string kanzi::readAsText ( File & file)

Loads contents of a file into a string.

Parameters
fileThe file to load. Upon successful return the file offset is set to the end of the file.
Returns
String containing the contents of the file from the current file offset to the end of the file.

◆ readAsTextLines()

vector< string > kanzi::readAsTextLines ( File & file)

Loads contents of a file into a vector of strings for each line.

Parameters
fileThe file to load. Upon successful return the file offset is set to the end of the file.
Returns
Vector containing a string for each line from the current file offset to the end of the file.

◆ logArgumentToString() [3/3]

template<typename T >
string kanzi::logArgumentToString ( const T & value)

The logging subsystem uses this function to convert a value to string.

The Logging subsystem uses this function internally to convert log message format arguments to string, when the type of the format argument is user-defined. See Log message argument format specification.

If you define your own type and want to use objects of that type as format arguments in formatted log messages, you must provide specialization of this function template for the type you defined, or provide overload of the operator<< for your type required by the default implementation of this template function.

Parameters
valueThe value to be converted to string.
Returns
The string representation of value.

◆ componentAbs() [1/4]

ColorRGBA kanzi::componentAbs ( ColorRGBA v)
inline

Calculates component-wise absolute value for all elements and returns the resulting color.

Parameters
vColor input.
Returns
The result color.

◆ componentCeil() [1/4]

ColorRGBA kanzi::componentCeil ( ColorRGBA v)
inline

Calculates component-wise ceil value for all elements and returns the resulting color.

Parameters
vColor input.
Returns
The result color.

◆ componentFloor() [1/4]

ColorRGBA kanzi::componentFloor ( ColorRGBA v)
inline

Calculates component-wise floor value for all elements and returns the resulting color.

Parameters
vColor input.
Returns
The result color.

◆ componentRound() [1/4]

ColorRGBA kanzi::componentRound ( ColorRGBA v)
inline

Calculates component-wise rounded value for all elements and returns the resulting color.

Parameters
vColor input.
Returns
The result color.

◆ componentSqrt() [1/4]

ColorRGBA kanzi::componentSqrt ( ColorRGBA v)
inline

Calculates component-wise square root all elements and returns the resulting color.

Parameters
vColor input.
Returns
The result color.

◆ componentWiseMax() [1/6]

ColorRGBA kanzi::componentWiseMax ( ColorRGBA v1,
ColorRGBA v2 )
inline

Calculates component-wise maximum for all color elements and returns the resulting color.

Parameters
v1The first color.
v2The second color.
Returns
The result color.

◆ componentWiseMin() [1/6]

ColorRGBA kanzi::componentWiseMin ( ColorRGBA v1,
ColorRGBA v2 )
inline

Calculates component-wise minimum for all color elements and returns the resulting color.

Parameters
v1The first color.
v2The second color.
Returns
The result color.

◆ componentWiseMultiply() [1/7]

ColorRGBA kanzi::componentWiseMultiply ( ColorRGBA v1,
ColorRGBA v2 )
inline

Multiplies component-wise all color elements and returns the resulting color.

Parameters
v1The first color.
v2The second color.
Returns
The result color.

◆ componentWiseDivide() [1/6]

ColorRGBA kanzi::componentWiseDivide ( ColorRGBA v1,
ColorRGBA v2 )
inline

Divides component-wise all color elements and returns the resulting color.

Parameters
v1The first color.
v2The second color.
Returns
The result color.

◆ componentWiseRemainder() [1/4]

ColorRGBA kanzi::componentWiseRemainder ( ColorRGBA v1,
ColorRGBA v2 )
inline

Calculates component-wise the remainder for all color elements and returns the resulting color.

Parameters
v1The first color.
v2The second color.
Returns
The result color.

◆ componentAdd() [1/4]

ColorRGBA kanzi::componentAdd ( ColorRGBA v,
float scalar )
inline

Adds a value to all color elements and returns the resulting color.

Parameters
vColor.
scalarValue
Returns
Result color.

◆ componentSubtract() [1/4]

ColorRGBA kanzi::componentSubtract ( ColorRGBA v,
float scalar )
inline

Subtracts a value from all color elements and returns the resulting color.

Parameters
vColor.
scalarValue
Returns
Result color.

◆ operator+() [1/16]

Adds a color and a scalar and returns the sum.

Parameters
v1Left hand side scalar.
v2Right hand side color.
Returns
This color.

◆ operator+() [2/16]

Adds a color and a scalar and returns the sum.

Parameters
v1Left hand side color.
v2Right hand side scalar.
Returns
This color.

◆ operator+() [3/16]

Adds two colors and returns the sum.

Parameters
v1Left hand side color.
v2Right hand side color.
Returns
The result color.

◆ operator-() [1/8]

Subtracts two colors and returns the difference.

Parameters
v1Left hand side color.
v2Right hand side color.
Returns
The result color.

◆ operator*() [1/13]

ColorRGBA kanzi::operator* ( ColorRGBA v,
float scalar )
inline

Multiplies all color elements with a scalar and returns the resulting color.

Parameters
vA color.
scalarA scalar.
Returns
The result color.

◆ operator*() [2/13]

ColorRGBA kanzi::operator* ( float scalar,
ColorRGBA v )
inline

Multiplies all color elements with a scalar and returns the resulting color.

Parameters
scalarA scalar.
vA color.
Returns
The result color.

◆ operator/() [1/4]

ColorRGBA kanzi::operator/ ( ColorRGBA v,
float scalar )
inline

Divides all color elements with a scalar and returns the resulting color.

Parameters
vA color.
scalarA scalar.
Returns
The result color.

◆ operator-() [2/8]

Negates all color elements and returns the resulting color.

Parameters
vA color.
Returns
The result color.

◆ operator+() [4/16]

Unary plus, doesn't do anything and returns the resulting color.

Parameters
vA color.
Returns
The result color.

◆ operator==() [6/13]

bool kanzi::operator== ( ColorRGBA v1,
ColorRGBA v2 )
inline

Compares two colors for equality.

Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
v1Left hand side color.
v2Right hand side color.
Returns
True if colors are equal.

◆ operator!=() [6/13]

Compares two colors for inequality.

Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
v1Left hand side color.
v2Right hand side color.
Returns
True if colors are different.

◆ dotProduct() [1/5]

float kanzi::dotProduct ( ColorRGBA v1,
ColorRGBA v2 )
inline

Calculates the dot product of two colors.

Parameters
v1The first color.
v2The second color.
Returns
The dot product of the colors.

◆ sRGBToLinear() [1/4]

ColorRGBA kanzi::sRGBToLinear ( const ColorRGBA & cs)
inline

Converts to whole ColorRGBA from sRGB to linear.

Parameters
csColor in sRGB format.
Returns
Color in linear format.

◆ linearTosRGB() [1/4]

ColorRGBA kanzi::linearTosRGB ( const ColorRGBA & cs)
inline

Converts whole ColorRGBA color from linear to sRGB.

Parameters
csColor in linear format.
Returns
Color in sRGB format.

◆ floatToHalfFloat()

uint16_t kanzi::floatToHalfFloat ( float f)

Converts float to 16 bits representing a half float.

◆ halfFloatToFloat()

float kanzi::halfFloatToFloat ( uint16_t halfFloatNumber)

Converts 16 bits representing a half float to a float.

◆ componentWiseClamp()

template<typename T >
T kanzi::componentWiseClamp ( const T & value,
const T & minvalue,
const T & maxvalue )
inline

Clamps all vector fields between the given minimum and the maximum values.

Parameters
valueThe value vector to clamp.
minvalueThe vector with lower bounds.
maxvalueThe vector with upper bounds. The upper bounds must be at least the lower bounds.
Returns
The value vector with values clamped between the minimum and the maximum.

◆ getCloseToZeroRange()

constexpr float kanzi::getCloseToZeroRange ( )
constexpr

Returns the largest value of a floating point number which is considered as "almost zero".

◆ isCloseToZero()

bool kanzi::isCloseToZero ( float value)
inline

Checks if floating point value is too close to zero.

◆ isInClosedInterval()

template<class T >
bool kanzi::isInClosedInterval ( T value,
T min,
T max )
inline

Check whether value is in [min, max] (an interval inclusive of the limit points).

◆ positiveModulo() [1/2]

unsigned int kanzi::positiveModulo ( int dividend,
unsigned int divisor )
inline

Returns the positive modulo(dividend % divisor) for signed numbers in a way that negative numbers are treated as an extension instead of mirroring compared to positive numbers.

For example, positiveModulo(-16, 5) = 4. Results are undefined if divisor is not greater than zero, hence the assert.

◆ positiveModulo() [2/2]

float kanzi::positiveModulo ( float dividend,
float divisor )
inline

Same as positiveModulo(), but for floating point numbers.

Results are undefined if divisor is not greater than zero, hence the assert.

◆ degreesToRadians()

constexpr float kanzi::degreesToRadians ( float angleInDegrees)
constexpr

Converts degrees to radians.

◆ radiansToDegrees()

constexpr float kanzi::radiansToDegrees ( float angleInRadians)
constexpr

Converts radians to degrees.

◆ floatIsAlmostEqualUlps()

bool kanzi::floatIsAlmostEqualUlps ( float valueA,
float valueB,
unsigned int maxUlps )
inline

Floating point helper methods.

Check if two IEEE 754 binary32 floats are equal up to a given number of ulps.

◆ floatIsAlmostEqualAbsolute()

bool kanzi::floatIsAlmostEqualAbsolute ( float valueA,
float valueB,
float maxAbsoluteDifference )
inline

Check if two floats are equal up to a given difference.

◆ floatIsEqual()

constexpr bool kanzi::floatIsEqual ( float valueA,
float valueB )
constexpr

Check if two floats are equal.

The idea behind this method is to make float comparison notable, as comparing floats for equality is unsafe and prone to bugs.

◆ floatIsAlmostEqual()

bool kanzi::floatIsAlmostEqual ( float valueA,
float valueB )
inline

Check if two floats are approximately equal.

◆ floatToUint()

constexpr unsigned int kanzi::floatToUint ( float value)
constexpr

Casts a float to unsigned int.

Directly casting a negative float to an unsigned int leads to an undefined behavior. Casting the floating point number to a signed integer number first and then to an unsigned integer number. For details refer to: https://stackoverflow.com/questions/50134795/cast-float-to-unsigned-int-in-c-with-gcc.

◆ step() [1/2]

constexpr int kanzi::step ( int edge,
int value )
constexpr

Calculate step for integers.

Parameters
edgeEdge value.
valueValue.
Returns
1 if value is greater or equal to edge, 0 otherwise.

◆ step() [2/2]

constexpr float kanzi::step ( float edge,
float value )
constexpr

Calculate step for floating point values.

Parameters
edgeEdge value.
valueValue.
Returns
1.0f if value is greater or equal to edge, 0.0f otherwise.

◆ sRGBToLinear() [2/4]

float kanzi::sRGBToLinear ( float cs)

Conversion from sRGB to linear for default gamma 2.2.

See also
https://en.wikipedia.org/wiki/SRGB
Parameters
csInput color value in sRGB.
Returns
Color value in linear.

◆ linearTosRGB() [2/4]

float kanzi::linearTosRGB ( float cl)

Conversion from linear to sRGB for default gamma 2.2.

See also
https://en.wikipedia.org/wiki/SRGB
Parameters
clInput color value in linear.
Returns
Color value in sRGB.

◆ sRGBToHSLColor() [1/3]

tuple< float, float, float > kanzi::sRGBToHSLColor ( float r,
float g,
float b )

Converts a color from the sRGB color space to the HSL color space.

Assumes that the values of the red, green, and blue color channels are contained in the set [0, 1].

See also
https://en.wikipedia.org/wiki/SRGB
https://en.wikipedia.org/wiki/HSL_and_HSV
Parameters
rRed.
gGreen.
bBlue.
Returns
Color value in the HSL (hue, saturation, lightness) color space. Each float in the tuple is contained in the set [0, 1].

◆ hslTosRGBColor() [1/3]

tuple< float, float, float > kanzi::hslTosRGBColor ( float h,
float s,
float l )

Converts a color from the HSL color space to the sRGB color space.

Assumes that the values of hue, saturation, and lightness are contained in the set [0, 1].

See also
https://en.wikipedia.org/wiki/SRGB
https://en.wikipedia.org/wiki/HSL_and_HSV
Parameters
hHue.
sSaturation.
lLightness.
Returns
Color value in the sRGB color space. Each float in the tuple is contained in the set [0, 1].

◆ operator*() [3/13]

Multiplies two matrices and returns the product.

Parameters
m1Left-hand side matrix.
m2Right-hand side matrix.
Returns
The result matrix.

◆ operator*() [4/13]

Multiplies matrix with vector and returns the product.

Parameters
mLeft-hand side matrix.
vRight-hand side vector.
Returns
The result vector.

◆ operator*() [5/13]

Multiplies matrix with vector and returns the product.

Parameters
mLeft-hand side matrix.
vRight-hand side vector.
Returns
The result vector.

◆ operator==() [7/13]

bool kanzi::operator== ( Matrix3x3 left,
Matrix3x3 right )
inline

Equality operator.

Compares two matrices for equality. Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
leftLeft hand side matrix.
rightRight hand side matrix.
Returns
True if vectors are equal.

◆ operator!=() [7/13]

bool kanzi::operator!= ( Matrix3x3 left,
Matrix3x3 right )
inline

Inequality operator.

Compares two matrices for inequality. Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
leftLeft hand side matrix.
rightRight hand side matrix.
Returns
True if matrices are not equal, false if they are.

◆ inverse() [1/3]

optional< Matrix3x3 > kanzi::inverse ( const Matrix3x3 & matrix)

Applies an inversion to a matrix.

Parameters
matrixInput matrix.
Returns
Inverted matrix if the input matrix is invertible, nullopt otherwise.

◆ inverseAffine() [1/2]

optional< Matrix3x3 > kanzi::inverseAffine ( const Matrix3x3 & matrix)

Applies an inversion to an affine matrix.

Parameters
matrixInput matrix.
Returns
Inverted matrix if the input matrix is invertible, nullopt otherwise.

◆ isTranslationOnly() [1/2]

bool kanzi::isTranslationOnly ( const Matrix3x3 & matrix)

Determines whether a matrix is translation-only.

Parameters
matrixInput matrix.
Returns
If the input matrix is translation-only, true, otherwise false.

◆ isScalingOnly()

bool kanzi::isScalingOnly ( const Matrix3x3 & matrix)

Determines whether a matrix is scaling-only.

Note: This function allows translation.

Parameters
matrixInput matrix.
Returns
If the input matrix is scaling-only, true, otherwise false.

◆ extractSRT() [1/2]

bool kanzi::extractSRT ( const Matrix3x3 & matrix,
Vector2 & scale,
float & rotationInRadians,
Vector2 & translation )

Extracts scale, rotation and translation information from a matrix.

Parameters
matrixInput matrix.
scaleScale vector.
rotationInRadiansRotation angle, in radians.
translationTranslation vector.
Returns
True if the matrix could be decomposed and the extraction of SRT components succeeded, false otherwise.

◆ normalized()

optional< Matrix3x3 > kanzi::normalized ( const Matrix3x3 & matrix)

Normalizes the input matrix.

The matrix must be an affine transformation.

Returns
A normalized Matrix3x3.

◆ matrixMultiplyVectorBy2x2()

Vector2 kanzi::matrixMultiplyVectorBy2x2 ( const Matrix3x3 & matrix,
const Vector2 vector )

Multiply a 2D vector with the top 2x2 part of a given matrix.

Parameters
matrixThe matrix that you want to multiply with a 2D vector.
vectorThe 2D vector that you want to multiply with a matrix.
Returns
The result of the multiplication.

◆ getDeterminant() [1/2]

float kanzi::getDeterminant ( const Matrix3x3 & matrix)

Calculates the determinant of the matrix.

Returns
Determinant of the matrix.

◆ getDeterminant2x2()

float kanzi::getDeterminant2x2 ( const Matrix3x3 & matrix)

Calculates the determinant of the 2X2 part of a matrix.

Returns
Determinant of the matrix.

◆ getTrace() [1/2]

float kanzi::getTrace ( const Matrix3x3 & matrix)

Calculates the trace of a matrix.

Returns
Trace of the matrix

◆ componentWiseMultiply() [2/7]

Matrix3x3 kanzi::componentWiseMultiply ( const Matrix3x3 & m1,
const Matrix3x3 & m2 )
inline

Multiplies matrix components component-wise and returns the resulting matrix.

Parameters
m1The first matrix.
m2The second matrix.
Returns
The result matrix.
Since
Kanzi 3.9.9

◆ componentWiseDivide() [2/6]

Matrix3x3 kanzi::componentWiseDivide ( const Matrix3x3 & m1,
const Matrix3x3 & m2 )
inline

Divides matrix components component-wise and returns the resulting matrix.

Parameters
m1The first matrix.
m2The second matrix.
Returns
The result matrix.
Since
Kanzi 3.9.9

◆ componentWiseMax() [2/6]

Matrix3x3 kanzi::componentWiseMax ( Matrix3x3 v1,
Matrix3x3 v2 )
inline

Calculates the component-wise maximum for all matrix elements and returns the resulting matrix.

Parameters
v1The first matrix.
v2The second matrix.
Returns
The result matrix.
Since
Kanzi 3.9.9

◆ componentWiseMin() [2/6]

Matrix3x3 kanzi::componentWiseMin ( Matrix3x3 v1,
Matrix3x3 v2 )
inline

Calculates the component-wise minimum for all matrix elements and returns the resulting matrix.

Parameters
v1The first matrix.
v2The second matrix.
Returns
The result matrix.
Since
Kanzi 3.9.9

◆ operator*() [6/13]

Multiplies two matrices and returns the product.

Parameters
leftLeft-hand side matrix.
rightRight-hand side matrix.
Returns
The result matrix.

◆ multiplyAffine()

Matrix4x4 kanzi::multiplyAffine ( const Matrix4x4 & left,
const Matrix4x4 & right )

Multiplies two affine matrices and returns the product.

Parameters
leftLeft hand side matrix.
rightRight hand side matrix.
Returns
The result matrix.

◆ orthonormalizeBase()

Matrix4x4 kanzi::orthonormalizeBase ( const Matrix4x4 & matrix)

Orthonormalizes base vectors of the given matrix.

The result is in out_matrix. The orthonormalization is done using the Gram-Schmidt process. Z axis is kept still, then Y is handled, then X. You can use this function to prevent value drift.

Parameters
matrixInput matrix.
Returns
The orthonormalized matrix.

◆ matrixMultiplyVectorBy3x3()

Vector3 kanzi::matrixMultiplyVectorBy3x3 ( const Matrix4x4 & matrix,
const Vector3 vector )

Multiplies a 3D vector with the top 3x3 part of a given matrix.

Parameters
matrixThe matrix that you want to multiply with a 3D vector.
vectorThe 3D vector that you want to multiply with a matrix.
Returns
The result of the multiplication.

◆ inverse() [2/3]

optional< Matrix4x4 > kanzi::inverse ( const Matrix4x4 & matrix)

Applies an inversion to a matrix.

Parameters
matrixInput matrix.
Returns
Inverted matrix if the input matrix is invertible, nullopt otherwise.

◆ inverseAffine() [2/2]

optional< Matrix4x4 > kanzi::inverseAffine ( const Matrix4x4 & matrix)

Applies an inversion to an affine matrix.

Parameters
matrixInput matrix.
Returns
Inverted matrix if the input matrix is invertible, nullopt otherwise.

◆ inverseOrthogonal()

optional< Matrix4x4 > kanzi::inverseOrthogonal ( const Matrix4x4 & matrix)

Applies an inversion to an orthogonal affine matrix.

Parameters
matrixInput matrix.
Returns
Inverted matrix if the input matrix is invertible, nullopt otherwise.

◆ isTranslationOnly() [2/2]

bool kanzi::isTranslationOnly ( const Matrix4x4 & matrix)

Returns whether a matrix is translation-only.

Parameters
matrixInput matrix.
Returns
If the input matrix is translation-only, true, otherwise false.

◆ extractSRT() [2/2]

bool kanzi::extractSRT ( const Matrix4x4 & matrix,
Vector3 & scale,
Vector3 & rotationInRadians,
Vector3 & translation )

Extracts from a matrix the scale, rotation, and translation information.

Parameters
matrixInput matrix.
scaleScale vector.
rotationInRadiansRotation vector, rotation angle in radians.
translationTranslation vector.

◆ extract3x3()

Matrix3x3 kanzi::extract3x3 ( const Matrix4x4 & matrix)

Extracts the 3x3 rotation and scaling part of a matrix.

◆ normalizeBase()

Matrix4x4 kanzi::normalizeBase ( const Matrix4x4 & matrix)

Normalizes base vectors of a matrix.

The matrix must be an affine transformation.

Returns
Matrix4x4 with base vectors normalized.

◆ getDeterminant() [2/2]

float kanzi::getDeterminant ( const Matrix4x4 & matrix)

Calculates the determinant of a matrix.

Parameters
matrixThe matrix for which you want to return the determinant.
Returns
Determinant of the matrix.

◆ getDeterminant3x3()

float kanzi::getDeterminant3x3 ( const Matrix4x4 & matrix)

Calculates the determinant of the 3x3 part of a matrix.

Parameters
matrixThe matrix for which you want to return the determinant.
Returns
Determinant of the matrix.

◆ getTrace() [2/2]

float kanzi::getTrace ( const Matrix4x4 & matrix)

Calculates the trace of a matrix.

Returns
Trace of the matrix.

◆ createRelativeOrthogonalProjection()

Matrix4x4 kanzi::createRelativeOrthogonalProjection ( float near,
float far,
Matrix4x4::FieldOfViewType fovType,
float orthoSize,
float aspectRatio )

Creates an orthogonal projection matrix for a symmetrical viewing volume.

Parameters
nearCamera near value.
farCamera far value.
fovTypeTells whether the orthoSize parameter is the width or height of the viewing box.
orthoSizeSpecifies the size of the viewing box (either width of height).
aspectRatioSpecifies the aspect ratio of the viewing box.
Returns
Orthogonal projection matrix.
See also
Matrix4x4::createOrthogonalProjection

◆ calculateCameraViewPosition()

optional< Vector4 > kanzi::calculateCameraViewPosition ( Matrix4x4 projectionCameraMatrix)

Calculates a homogeneous camera view position that you can use to calculate the view direction in a shader.

For orthogonal projections the w-component of the viewpoint is 0 to indicate that the viewpoint is at infinity.

Parameters
projectionCameraMatrixThe matrix to use for calculating the viewpoint.
Returns
Homogeneous viewpoint.
See also
Matrix4x4::createOrthogonalProjection

◆ componentWiseMultiply() [3/7]

Matrix4x4 kanzi::componentWiseMultiply ( const Matrix4x4 & m1,
const Matrix4x4 & m2 )
inline

Multiplies matrix components component-wise and returns the resulting matrix.

Parameters
m1The first matrix.
m2The second matrix.
Returns
The result matrix.
Since
Kanzi 3.9.9

◆ componentWiseDivide() [3/6]

Matrix4x4 kanzi::componentWiseDivide ( const Matrix4x4 & m1,
const Matrix4x4 & m2 )
inline

Divides matrix components component-wise and returns the resulting matrix.

Parameters
m1The first matrix.
m2The second matrix.
Returns
The result matrix.
Since
Kanzi 3.9.9

◆ componentWiseMax() [3/6]

Matrix4x4 kanzi::componentWiseMax ( Matrix4x4 v1,
Matrix4x4 v2 )
inline

Calculates the component-wise maximum for all matrix elements and returns the resulting matrix.

Parameters
v1The first matrix.
v2The second matrix.
Returns
The result matrix.
Since
Kanzi 3.9.9

◆ componentWiseMin() [3/6]

Matrix4x4 kanzi::componentWiseMin ( Matrix4x4 v1,
Matrix4x4 v2 )
inline

Calculates the component-wise minimum for all matrix elements and returns the resulting matrix.

Parameters
v1The first matrix.
v2The second matrix.
Returns
The result matrix.
Since
Kanzi 3.9.9

◆ calculateWorldSpaceAABB()

Box kanzi::calculateWorldSpaceAABB ( const OrientedBoundingBox & orientedBoundingBox)

Gets a minimum size world space axis-aligned bounding box that encloses this transformed box.

Parameters
orientedBoundingBoxThe transformed box.
Returns
Minimum size axis-aligned bounding box that contains all of the points in the given transformed bounding box.

◆ planeIntersectRay()

optional< PlaneRayIntersection > kanzi::planeIntersectRay ( const Plane & plane,
const Ray & ray,
const float parallelTolerance )

Tests whether a plane intersects with the given ray, and returns the point of intersection and the distance of the intersection from the origin of a plane.

The method checks the parallelness between a plane and a ray using a tolerance value. If the tolerance test does not pass, the output values are filled with NaNs and the method returns false.

Parameters
planeThe plane that you want to check for intersection.
rayThe ray that you want to check for intersection.
parallelToleranceThe tolerance value to check the parallelness.
Returns
If the ray intersects with the plane, returns an optional PlaneRayIntersection struct, otherwise nullopt.

◆ planeIntersectPlane()

optional< PlanePlaneIntersection > kanzi::planeIntersectPlane ( const Plane & plane1,
const Plane & plane2,
float parallelTolerance )

Checks whether two planes intersect and returns a point and direction vector for the line of intersection.

The planes do not have to be normalized. The method uses a tolerance value to check whether the planes are parallel. If the tolerance test does not pass, the method returns nullopt.

Parameters
plane1The first plane to use for the intersection calculation.
plane2The second plane to use for the intersection calculation.
parallelToleranceThe tolerance value for checking the parallelism.
Returns
If the planes intersect, returns an optional PlanePlaneIntersection struct, otherwise nullopt.

◆ componentWiseMultiply() [4/7]

Quaternion kanzi::componentWiseMultiply ( const Quaternion & q1,
const Quaternion & q2 )
inline

Multiplies quaternion components component-wise and returns the resulting quaternion.

Parameters
q1The first quaternion.
q2The second quaternion.
Returns
The result quaternion.

◆ dotProduct() [2/5]

float kanzi::dotProduct ( const Quaternion & q1,
const Quaternion & q2 )
inline

Calculates the dot product of two quaternions.

Parameters
q1The first quaternion.
q2The second quaternion.
Returns
The dot product of the quaternions.

◆ operator==() [8/13]

Equality comparison operator, compares if two quaternions are exactly equal.

Use this to compare if two quaternions are exactly the same, not good for rotation equality comparisons, as does not take floating point rounding errors into account.

Parameters
q1First quaternion.
q2Second quaternion.
Returns
True if equal, false if not.

◆ operator!=() [8/13]

Inequality comparison operator, compares if two quaternions are exactly not equal.

Use this to compare if two quaternions are not exactly the same. Not good for rotation equality comparisons, as does not take floating point rounding errors into account.

Parameters
q1First quaternion.
q2Second quaternion.
Returns
True if unequal, false if equal.

◆ inverse() [3/3]

Quaternion kanzi::inverse ( const Quaternion & q)
inline

Returns an inverse quaternion for a quaternion.

Parameters
qQuaternion to invert.
Returns
Inverse quaternion.

◆ operator*() [7/13]

Multiplies two quaternions.

You can combine a quaternion rotations by multiplying them: rotating a vector v by quaternion q1 * q2 is the same as rotating the vector first by q2 and then by q1.

Parameters
q1First quaternion.
q2Second quaternion.
Returns
Multiplied quaternion.

◆ rotateVector()

Vector3 kanzi::rotateVector ( const Quaternion & quaternion,
Vector3 vector )

Applies quaternion rotation to a vector.

Calculates q * v * q.conjugated(), for a quaternion q and a vector v.

Parameters
quaternionQuaternion rotation.
vectorVector that you want to rotate.
Returns
The rotated vector.

◆ quaternionToMatrix4x4()

Matrix4x4 kanzi::quaternionToMatrix4x4 ( const Quaternion & quaternion)

Converts a quaternion rotation to a 4x4 rotation matrix.

Parameters
quaternionQuaternion rotation.
Returns
Matrix4x4 with rotation values extracted from quaternion.

◆ matrix4x4ToQuaternion()

Quaternion kanzi::matrix4x4ToQuaternion ( const Matrix4x4 & matrix)

Creates a quaternion from Matrix4x4.

Extracts and calculates the quaternion components from passed in Matrix4x4. Use this when you already have the rotation stored in a 4x4 matrix and want to extract the rotation angles to a quaternion.

Parameters
matrixMatrix4x4 from which to extract and calculate the quaternion components.
Returns
Rotated and normalized quaternion.

◆ calculateEulerAngles()

Vector3 kanzi::calculateEulerAngles ( const Quaternion & quaternion)

Calculates Euler angles from a quaternion.

Kanzi Engine represents Euler angles as Tait-Bryan angles where the rotations are applied in the order x, y, and z.

Returns
Euler angles in radians.

◆ quaternionSlerp()

Quaternion kanzi::quaternionSlerp ( const Quaternion & q1,
const Quaternion & q2,
float interpolationTime )

Applies spherical linear interpolation (slerp) to two quaternions using the shortest path.

Use this to evaluate interpolation between two rotations at given interpolation time. Takes the shortest path of interpolation between two degrees, which amounts to maximum of 180 degrees of rotation in any direction.

Parameters
q1First quaternion.
q2Second quaternion.
interpolationTimeInterpolation parameter in range [0 .. 1].
Returns
Interpolated rotated quaternion.

◆ quaternionSlerpLongerPath()

Quaternion kanzi::quaternionSlerpLongerPath ( const Quaternion & q1,
const Quaternion & q2,
float interpolationTime )

Applies spherical linear interpolation (slerp) to two quaternion using the longer path.

Use this to evaluate interpolation between two rotations at given interpolation time. Takes the longer path to the result. Interpolates the whole angle difference between the two quaternion rotations. For example, from 0 to 270 rotates the whole 270 degrees.

Parameters
q1First quaternion.
q2Second quaternion.
interpolationTimeInterpolation parameter in range [0 .. 1].
Returns
Interpolated rotated quaternion.

◆ rayIntersectBox() [1/2]

RayBoxIntersection kanzi::rayIntersectBox ( const Ray & ray,
const Box & box,
const Matrix4x4 & boxOrientation )

Tests whether a ray intersects with a bounding box and returns the distance.

Parameters
rayThe ray that you want to trace.
boxThe bounding box on which the method traces the ray.
boxOrientationThe orientation of the bounding box.
Returns
RayBoxIntersection structure that contains the intersection information.

◆ rayIntersectBox() [2/2]

RayBoxIntersection kanzi::rayIntersectBox ( const Ray & ray,
const Vector3 minCorner,
const Vector3 maxCorner,
const Matrix4x4 & boxOrientation )

Tests whether a ray intersects with a bounding box and returns the distance.

Parameters
rayThe ray that you want to trace.
minCornerThe minimum corner of a minimum bounding box.
maxCornerThe maximum corner of a minimum bounding box.
boxOrientationThe orientation of the bounding box.
Returns
RayBoxIntersection structure that contains the intersection information.

◆ rayIntersectBoxBackface() [1/2]

RayBoxIntersection kanzi::rayIntersectBoxBackface ( const Ray & ray,
const Box & box,
const Matrix4x4 & boxOrientation )

Tests whether a ray intersects with the back faces of a bounding box and returns the distance.

Parameters
rayThe ray that you want to trace.
boxThe bounding box on which the method traces the ray.
boxOrientationThe orientation of the bounding box.
Returns
RayBoxIntersection structure that contains the intersection information.

◆ rayIntersectBoxBackface() [2/2]

RayBoxIntersection kanzi::rayIntersectBoxBackface ( const Ray & ray,
const Vector3 minCorner,
const Vector3 maxCorner,
const Matrix4x4 & boxOrientation )

Tests whether a ray intersects with the back faces of a bounding box and returns the distance.

Parameters
rayThe ray that you want to trace.
minCornerThe minimum corner of a minimum bounding box.
maxCornerThe maximum corner of a minimum bounding box.
boxOrientationBounding Box's orientation.
Returns
RayBoxIntersection structure that contains the intersection information.

◆ rayIntersectSphere()

optional< float > kanzi::rayIntersectSphere ( const Ray & ray,
const Vector3 spherePosition,
const float sphereRadius )

Tests whether a ray intersects with a sphere and returns the distance.

Parameters
rayThe ray that you want to trace.
spherePositionThe position of the sphere.
sphereRadiusThe radius of the sphere.
Returns
If the sphere intersects with the ray, the method returns the distance between the origin of the ray and the point of intersection, otherwise nullopt.

◆ rayIntersectCylinder()

optional< float > kanzi::rayIntersectCylinder ( const Ray & ray,
const float cylinderRadius,
const float cylinderHeight,
const Vector3 cylinderAxis,
const Matrix4x4 & cylinderTransform )

Tests whether a ray intersects with a cylinder aligned on the given unit-axis (within range [-height/2, height/2]).

The method first transforms the cylinder with the given transformation matrix.

Parameters
rayThe ray that you want to trace.
cylinderRadiusThe radius of the cylinder.
cylinderHeightThe height of the cylinder.
cylinderAxisThe axis of the cylinder.
cylinderTransformThe transformation matrix of the cylinder.
Returns
If the cylinder intersects with the ray, the method returns the distance between the origin of the ray and the point of intersection, otherwise nullopt.

◆ intersection()

template<typename T >
Rectangle< T > kanzi::intersection ( const Rectangle< T > & rectangle1,
const Rectangle< T > & rectangle2 )

Calculates intersection of the two rectangles.

Parameters
rectangle1First rectangle.
rectangle2Second rectangle.
Returns
Intersection rectangle.

◆ getUnion()

template<typename T >
Rectangle< T > kanzi::getUnion ( const Rectangle< T > & rectangle1,
const Rectangle< T > & rectangle2 )

Calculates union of the two rectangles.

Parameters
rectangle1First rectangle.
rectangle2Second rectangle.
Returns
Union rectangle.

◆ overlaps()

template<typename T >
bool kanzi::overlaps ( const Rectangle< T > & rectangle1,
const Rectangle< T > & rectangle2 )

Checks if the two given rectangles overlap, at least partially.

Parameters
rectangle1First rectangle.
rectangle2Second rectangle.
Returns
True if the rectangles overlaps, false otherwise.

◆ componentAbs() [2/4]

Vector2 kanzi::componentAbs ( Vector2 v)
inline

Calculates component-wise absolute value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentCeil() [2/4]

Vector2 kanzi::componentCeil ( Vector2 v)
inline

Calculates component-wise ceil value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentFloor() [2/4]

Vector2 kanzi::componentFloor ( Vector2 v)
inline

Calculates component-wise floor value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentRound() [2/4]

Vector2 kanzi::componentRound ( Vector2 v)
inline

Calculates component-wise rounded value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentSqrt() [2/4]

Vector2 kanzi::componentSqrt ( Vector2 v)
inline

Calculates component-wise square root all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentWiseMax() [4/6]

Vector2 kanzi::componentWiseMax ( Vector2 v1,
Vector2 v2 )
inline

Calculates the component-wise maximum for all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseMin() [4/6]

Vector2 kanzi::componentWiseMin ( Vector2 v1,
Vector2 v2 )
inline

Calculates the component-wise minimum for all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseMultiply() [5/7]

Vector2 kanzi::componentWiseMultiply ( Vector2 v1,
Vector2 v2 )
inline

Multiplies all vector elements component-wise and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseDivide() [4/6]

Vector2 kanzi::componentWiseDivide ( Vector2 v1,
Vector2 v2 )
inline

Divides all vector elements component-wise and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseRemainder() [2/4]

Vector2 kanzi::componentWiseRemainder ( Vector2 v1,
Vector2 v2 )
inline

Calculates component-wise the remainder for all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentAdd() [2/4]

Vector2 kanzi::componentAdd ( Vector2 v,
float scalar )
inline

Adds a value to all elements of a vector and returns the result.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ componentSubtract() [2/4]

Vector2 kanzi::componentSubtract ( Vector2 v,
float scalar )
inline

Subtracts a value from all elements of a vector and returns the result.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ componentAllLessThan() [1/3]

bool kanzi::componentAllLessThan ( Vector2 a,
Vector2 b )
inline

Returns whether each component of the first vector is less than the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is less than the corresponding component of the second vector, true, otherwise false.

◆ componentAllLessThanOrEqual() [1/3]

bool kanzi::componentAllLessThanOrEqual ( Vector2 a,
Vector2 b )
inline

Returns whether each component of the first vector is less than or equal to the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is less than or equal to the corresponding component of the second vector, true, otherwise false.

◆ componentAllGreaterThan() [1/3]

bool kanzi::componentAllGreaterThan ( Vector2 a,
Vector2 b )
inline

Returns whether each component of the first vector is greater than the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is greater than the corresponding component of the second vector, true, otherwise false.

◆ componentAllGreaterThanOrEqual() [1/3]

bool kanzi::componentAllGreaterThanOrEqual ( Vector2 a,
Vector2 b )
inline

Returns whether each component of the first vector is greater than or equal to the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is greater than or equal to the corresponding component of the second vector, true, otherwise false.

◆ operator+() [5/16]

Vector2 kanzi::operator+ ( float v1,
Vector2 v2 )
inline

Adds a scalar and a vector and returns the sum.

Parameters
v1Left hand side scalar.
v2Right hand side vector.
Returns
The result vector.

◆ operator+() [6/16]

Vector2 kanzi::operator+ ( Vector2 v1,
float v2 )
inline

Adds a vector and a scalar and returns the sum.

Parameters
v1Left hand side vector.
v2Right hand side scalar.
Returns
The result vector.

◆ operator+() [7/16]

Vector2 kanzi::operator+ ( Vector2 v1,
Vector2 v2 )
inline

Adds two vectors and returns the sum.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
The result vector.

◆ operator-() [3/8]

Vector2 kanzi::operator- ( Vector2 v1,
Vector2 v2 )
inline

Subtracts two vectors and returns the difference.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
The result vector.

◆ operator*() [8/13]

Vector2 kanzi::operator* ( Vector2 v,
float scalar )
inline

Multiplies all vector elements with a scalar and returns the resulting vector.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ operator*() [9/13]

Vector2 kanzi::operator* ( float scalar,
Vector2 v )
inline

Multiplies all vector elements with a scalar and returns the resulting vector.

Parameters
scalarA scalar.
vA vector.
Returns
The result vector.

◆ operator/() [2/4]

Vector2 kanzi::operator/ ( Vector2 v,
float scalar )
inline

Divides all vector elements with a scalar and returns the resulting vector.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ operator-() [4/8]

Negates all vector elements and returns the resulting vector.

Parameters
vA vector.
Returns
The result vector.

◆ operator+() [8/16]

Unary plus, doesn't do anything and returns the resulting vector.

Parameters
vA vector.
Returns
The result vector.

◆ operator==() [9/13]

bool kanzi::operator== ( Vector2 v1,
Vector2 v2 )
inline

Compares two vectors for equality.

Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
True if vectors are equal.

◆ operator!=() [9/13]

bool kanzi::operator!= ( Vector2 v1,
Vector2 v2 )
inline

Compares two vectors for inequality.

Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
True if vectors are different.

◆ dotProduct() [3/5]

float kanzi::dotProduct ( Vector2 v1,
Vector2 v2 )
inline

Calculates the dot product of two vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The dot product of the vectors.

◆ pseudoCrossProduct()

float kanzi::pseudoCrossProduct ( const Vector2 & left,
const Vector2 & right )
inline

Calculates pseudo-cross product of two 2D vectors.

U x V = Uy * Vx - Ux * Vy.

Parameters
leftThe first vector.
rightThe second vector.
Returns
The pseudo-cross product of the vectors.

◆ isfinite()

bool kanzi::isfinite ( Vector2 vec)
inline

Overloading of kanzi::isfinite for kanzi::Vector2.

Parameters
vecVector2 value.
Returns
If both elements of the Vector2 have finite value, true, otherwise false.

◆ componentAbs() [3/4]

Vector3 kanzi::componentAbs ( Vector3 v)
inline

Calculates component-wise absolute value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentCeil() [3/4]

Vector3 kanzi::componentCeil ( Vector3 v)
inline

Calculates component-wise ceil value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentFloor() [3/4]

Vector3 kanzi::componentFloor ( Vector3 v)
inline

Calculates component-wise floor value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentRound() [3/4]

Vector3 kanzi::componentRound ( Vector3 v)
inline

Calculates component-wise rounded value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentSqrt() [3/4]

Vector3 kanzi::componentSqrt ( Vector3 v)
inline

Calculates component-wise square root all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentWiseMax() [5/6]

Vector3 kanzi::componentWiseMax ( Vector3 v1,
Vector3 v2 )
inline

Calculates the component-wise maximum for all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseMin() [5/6]

Vector3 kanzi::componentWiseMin ( Vector3 v1,
Vector3 v2 )
inline

Calculates the component-wise minimum for all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseMultiply() [6/7]

Vector3 kanzi::componentWiseMultiply ( Vector3 v1,
Vector3 v2 )
inline

Multiplies component-wise all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseDivide() [5/6]

Vector3 kanzi::componentWiseDivide ( Vector3 v1,
Vector3 v2 )
inline

Divides component-wise all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseRemainder() [3/4]

Vector3 kanzi::componentWiseRemainder ( Vector3 v1,
Vector3 v2 )
inline

Calculates component-wise the remainder for all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentAdd() [3/4]

Vector3 kanzi::componentAdd ( Vector3 v,
float scalar )
inline

Adds a value to all elements of a vector and returns the result.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ componentSubtract() [3/4]

Vector3 kanzi::componentSubtract ( Vector3 v,
float scalar )
inline

Subtracts a value from all elements of a vector and returns the result.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ componentAllLessThan() [2/3]

bool kanzi::componentAllLessThan ( Vector3 a,
Vector3 b )
inline

Returns whether each component of the first vector is less than the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is less than the corresponding component of the second vector, true, otherwise false.

◆ componentAllLessThanOrEqual() [2/3]

bool kanzi::componentAllLessThanOrEqual ( Vector3 a,
Vector3 b )
inline

Returns whether each component of the first vector is less than or equal to the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is less than or equal to the corresponding component of the second vector, true, otherwise false.

◆ componentAllGreaterThan() [2/3]

bool kanzi::componentAllGreaterThan ( Vector3 a,
Vector3 b )
inline

Returns whether each component of the first vector is greater than the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is greater than the corresponding component of the second vector, true, otherwise false.

◆ componentAllGreaterThanOrEqual() [2/3]

bool kanzi::componentAllGreaterThanOrEqual ( Vector3 a,
Vector3 b )
inline

Returns whether each component of the first vector is greater than or equal to the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is greater than or equal to the corresponding component of the second vector, true, otherwise false.

◆ operator+() [9/16]

Vector3 kanzi::operator+ ( float v1,
Vector3 v2 )
inline

Adds a scalar and a vector and returns the sum.

Parameters
v1Left hand side scalar.
v2Right hand side vector.
Returns
The result vector.

◆ operator+() [10/16]

Vector3 kanzi::operator+ ( Vector3 v1,
float v2 )
inline

Adds a vector and a scalar and returns the sum.

Parameters
v1Left hand side vector.
v2Right hand side scalar.
Returns
The result vector.

◆ operator+() [11/16]

Vector3 kanzi::operator+ ( Vector3 v1,
Vector3 v2 )
inline

Adds two vectors and returns the sum.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
The result vector.

◆ operator-() [5/8]

Vector3 kanzi::operator- ( Vector3 v1,
Vector3 v2 )
inline

Subtracts two vectors and returns the difference.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
The result vector.

◆ operator*() [10/13]

Vector3 kanzi::operator* ( Vector3 v,
float scalar )
inline

Multiplies all vector elements with a scalar and returns the resulting vector.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ operator*() [11/13]

Vector3 kanzi::operator* ( float scalar,
Vector3 v )
inline

Multiplies all vector elements with a scalar and returns the resulting vector.

Parameters
scalarA scalar.
vA vector.
Returns
The result vector.

◆ operator/() [3/4]

Vector3 kanzi::operator/ ( Vector3 v,
float scalar )
inline

Divides all vector elements with a scalar and returns the resulting vector.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ operator-() [6/8]

Negates all vector elements and returns the resulting vector.

Parameters
vA vector.
Returns
The result vector.

◆ operator+() [12/16]

Unary plus, doesn't do anything and returns the resulting vector.

Parameters
vA vector.
Returns
The result vector.

◆ operator==() [10/13]

bool kanzi::operator== ( Vector3 v1,
Vector3 v2 )
inline

Compares two vectors for equality.

Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
True if vectors are equal.

◆ operator!=() [10/13]

bool kanzi::operator!= ( Vector3 v1,
Vector3 v2 )
inline

Compares two vectors for inequality.

Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
True if vectors are different.

◆ dotProduct() [4/5]

float kanzi::dotProduct ( Vector3 v1,
Vector3 v2 )
inline

Calculates the dot product of two vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The dot product of the vectors.

◆ crossProduct() [1/2]

Vector3 kanzi::crossProduct ( Vector3 v1,
Vector3 v2 )
inline

Calculates the cross product of two vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The cross product of the vectors.

◆ getOrthogonalVector()

Vector3 kanzi::getOrthogonalVector ( Vector3 v)
inline

Finds a vector that is orthogonal to the given vector.

Parameters
vSource vector. Length must be 1.
Returns
Vector orthogonal to the source vector. Not necessarily of unit length.

◆ sRGBToLinear() [3/4]

Vector3 kanzi::sRGBToLinear ( const Vector3 & vec)
inline

Converts to whole Vector3 from sRGB to linear.

Since sRGB-to-linear conversion does not take alpha into account, it is possible to interpret Vector3 as just the RGB components.

Parameters
vecVector3 representing color in sRGB format.
Returns
Vector3 representing color in linear format.

◆ linearTosRGB() [3/4]

Vector3 kanzi::linearTosRGB ( const Vector3 & vec)
inline

Converts to whole Vector3 from linear to sRGB.

Since linear-to-sRGB conversion does not take alpha into account, it is possible to interpret Vector3 as just the RGB components.

Parameters
vecVector3 representing color in linear format.
Returns
Vector3 representing color in sRGB format.

◆ hslTosRGBColor() [2/3]

Vector3 kanzi::hslTosRGBColor ( const Vector3 & vec)
inline

Converts a Vector3 from HSL color space to sRGB color space.

Since the conversion does not take the alpha channel into account, it is possible to interpret the returned Vector3 as the red, green, and blue components.

Parameters
vecVector3 that represents a color in the HSL color space.
Returns
Vector3 that represents the color in the sRGB color space.

◆ sRGBToHSLColor() [2/3]

Vector3 kanzi::sRGBToHSLColor ( const Vector3 & vec)
inline

Converts a Vector3 from sRGB color space to HSL color space.

Since the conversion does not take the alpha channel into account, it is possible to interpret the returned Vector3 as the hue, saturation, and lightness components.

Parameters
vecVector3 that represents a color in the sRGB color space.
Returns
Vector3 that represents the color in the HSL color space.

◆ componentAbs() [4/4]

Vector4 kanzi::componentAbs ( Vector4 v)
inline

Calculates component-wise absolute value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentCeil() [4/4]

Vector4 kanzi::componentCeil ( Vector4 v)
inline

Calculates component-wise ceil value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentFloor() [4/4]

Vector4 kanzi::componentFloor ( Vector4 v)
inline

Calculates component-wise floor value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentRound() [4/4]

Vector4 kanzi::componentRound ( Vector4 v)
inline

Calculates component-wise rounded value for all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentSqrt() [4/4]

Vector4 kanzi::componentSqrt ( Vector4 v)
inline

Calculates component-wise square root all elements and returns resulting vector.

Parameters
vVector input.
Returns
The result vector.

◆ componentWiseMax() [6/6]

Vector4 kanzi::componentWiseMax ( Vector4 v1,
Vector4 v2 )
inline

Calculates the component-wise maximum for all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseMin() [6/6]

Vector4 kanzi::componentWiseMin ( Vector4 v1,
Vector4 v2 )
inline

Calculates the component-wise minimum for all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseMultiply() [7/7]

Vector4 kanzi::componentWiseMultiply ( Vector4 v1,
Vector4 v2 )
inline

Multiplies component-wise all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseDivide() [6/6]

Vector4 kanzi::componentWiseDivide ( Vector4 v1,
Vector4 v2 )
inline

Divides component-wise all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentWiseRemainder() [4/4]

Vector4 kanzi::componentWiseRemainder ( Vector4 v1,
Vector4 v2 )
inline

Calculates component-wise the remainder for all vector elements and returns the resulting vector.

Parameters
v1The first vector.
v2The second vector.
Returns
The result vector.

◆ componentAdd() [4/4]

Vector4 kanzi::componentAdd ( Vector4 v,
float scalar )
inline

Adds a value to all elements of a vector and returns the result.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ componentSubtract() [4/4]

Vector4 kanzi::componentSubtract ( Vector4 v,
float scalar )
inline

Subtracts a value from all elements of a vector and returns the result.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ componentAllLessThan() [3/3]

bool kanzi::componentAllLessThan ( Vector4 a,
Vector4 b )
inline

Returns whether each component of the first vector is less than the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is less than the corresponding component of the second vector, true, otherwise false.

◆ componentAllLessThanOrEqual() [3/3]

bool kanzi::componentAllLessThanOrEqual ( Vector4 a,
Vector4 b )
inline

Returns whether each component of the first vector is less than or equal to the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is less than or equal to the corresponding component of the second vector, true, otherwise false.

◆ componentAllGreaterThan() [3/3]

bool kanzi::componentAllGreaterThan ( Vector4 a,
Vector4 b )
inline

Returns whether each component of the first vector is greater than the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is greater than the corresponding component of the second vector, true, otherwise false.

◆ componentAllGreaterThanOrEqual() [3/3]

bool kanzi::componentAllGreaterThanOrEqual ( Vector4 a,
Vector4 b )
inline

Returns whether each component of the first vector is greater than or equal to the corresponding component of the second vector.

Parameters
aFirst vector.
bSecond vector.
Returns
If each component of the first vector is greater than or equal to the corresponding component of the second vector, true, otherwise false.

◆ operator+() [13/16]

Vector4 kanzi::operator+ ( float v1,
Vector4 v2 )
inline

Adds a scalar and a vector and returns the sum.

Parameters
v1Left hand side scalar.
v2Right hand side vector.
Returns
The result vector.

◆ operator+() [14/16]

Vector4 kanzi::operator+ ( Vector4 v1,
float v2 )
inline

Adds a vector and a scalar and returns the sum.

Parameters
v1Left hand side vector.
v2Right hand side scalar.
Returns
The result vector.

◆ operator+() [15/16]

Vector4 kanzi::operator+ ( Vector4 v1,
Vector4 v2 )
inline

Adds two vectors and returns the sum.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
The result vector.

◆ operator-() [7/8]

Vector4 kanzi::operator- ( Vector4 v1,
Vector4 v2 )
inline

Subtracts two vectors and returns the difference.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
The result vector.

◆ operator*() [12/13]

Vector4 kanzi::operator* ( Vector4 v,
float scalar )
inline

Multiplies all vector elements with a scalar and returns the resulting vector.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ operator*() [13/13]

Vector4 kanzi::operator* ( float scalar,
Vector4 v )
inline

Multiplies all vector elements with a scalar and returns the resulting vector.

Parameters
scalarA scalar.
vA vector.
Returns
The result vector.

◆ operator/() [4/4]

Vector4 kanzi::operator/ ( Vector4 v,
float scalar )
inline

Divides all vector elements with a scalar and returns the resulting vector.

Parameters
vA vector.
scalarA scalar.
Returns
The result vector.

◆ operator-() [8/8]

Negates all vector elements and returns the resulting vector.

Parameters
vA vector.
Returns
The result vector.

◆ operator+() [16/16]

Unary plus, doesn't do anything and returns the resulting vector.

Parameters
vA vector.
Returns
The result vector.

◆ operator==() [11/13]

bool kanzi::operator== ( Vector4 v1,
Vector4 v2 )
inline

Compares two vectors for equality.

Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
True if vectors are equal.

◆ operator!=() [11/13]

bool kanzi::operator!= ( Vector4 v1,
Vector4 v2 )
inline

Compares two vectors for inequality.

Note that this is a floating point comparison without any tolerance, so you probably don't want to use this.

Parameters
v1Left hand side vector.
v2Right hand side vector.
Returns
True if vectors are different.

◆ dotProduct() [5/5]

float kanzi::dotProduct ( Vector4 v1,
Vector4 v2 )
inline

Calculates the dot product of two vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The dot product of the vectors.

◆ crossProduct() [2/2]

Vector4 kanzi::crossProduct ( Vector4 v1,
Vector4 v2 )
inline

Calculates the cross product of two vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The cross product of the vectors.

◆ sRGBToLinear() [4/4]

Vector4 kanzi::sRGBToLinear ( const Vector4 & vec)
inline

Conversion to whole Vector4 from sRGB to linear.

Parameters
vecVector4 representing color in sRGB format.
Returns
Vector4 representing color in linear format.

◆ linearTosRGB() [4/4]

Vector4 kanzi::linearTosRGB ( const Vector4 & vec)
inline

Conversion to whole Vector4 from linear to sRGB.

Parameters
vecVector4 representing color in linear format.
Returns
Vector4 representing color in sRGB format.

◆ sRGBToHSLColor() [3/3]

Vector4 kanzi::sRGBToHSLColor ( const Vector4 & vec)
inline

Converts a Vector4 from RGBA color space to HSLA color space.

The function passes the value of the alpha channel as is.

Parameters
vecVector4 that represents the red, green, blue, and alpha values of the color.
Returns
Vector4 that represents the hue, saturation, lightness, and alpha values of the color.

◆ hslTosRGBColor() [3/3]

Vector4 kanzi::hslTosRGBColor ( const Vector4 & vec)
inline

Converts a Vector4 from HSLA color space to RGBA color space.

The function passes the value of the alpha channel as is.

Parameters
vecVector4 that represents the hue, saturation, lightness, and alpha values of the color.
Returns
Vector4 that represents the red, green, blue, and alpha values of the color.

◆ registerMetaclass()

template<typename T >
void kanzi::registerMetaclass ( ObjectFactory & objectFactory)

◆ overrideMetaclass()

template<typename T >
void kanzi::overrideMetaclass ( ObjectFactory & objectFactory)

◆ convertUTF8ToWideChar()

wstring kanzi::convertUTF8ToWideChar ( string_view utf8)

Converts a given UTF-8 string view into a Win32-compatible wide character string.

Parameters
utf8String to convert. Must be UTF-8.
Returns
Corresponding wide character string.

◆ convertWideCharToUTF8()

string kanzi::convertWideCharToUTF8 ( wstring_view wchar)

Converts a given Win32-compatible wide character string view into a UTF-8 string.

Parameters
wcharWide character string to convert.
Returns
Corresponding UTF-8 string.

◆ convertUTF8ToWin32()

Win32String kanzi::convertUTF8ToWin32 ( string_view utf8)
inline

◆ convertWideCharToWin32()

Win32String kanzi::convertWideCharToWin32 ( wstring_view wchar)
inline

◆ convertWin32ToUTF8()

string kanzi::convertWin32ToUTF8 ( Win32StringView win32)
inline

◆ convertWin32ToWideChar()

wstring kanzi::convertWin32ToWideChar ( Win32StringView win32)
inline

◆ durationToTimespec()

timespec kanzi::durationToTimespec ( chrono::nanoseconds duration)

Converts C++ nanoseconds to POSIX native nanosecond format.

◆ durationToTimeval()

timeval kanzi::durationToTimeval ( chrono::microseconds duration)

Converts C++ microsecond to POSIX native microsecond format.

◆ typeToPropertyDataType()

template<typename T >
PropertyDataType kanzi::typeToPropertyDataType ( )
inline

Reverse lookup for data type.

Returns
Property data type for templated type.
Since
Kanzi 3.9.6

◆ typeToPropertyDataType< float >()

◆ typeToPropertyDataType< int >()

◆ typeToPropertyDataType< bool >()

◆ typeToPropertyDataType< ColorRGBA >()

◆ typeToPropertyDataType< Vector2 >()

◆ typeToPropertyDataType< Vector3 >()

◆ typeToPropertyDataType< Vector4 >()

◆ typeToPropertyDataType< Matrix3x3 >()

◆ typeToPropertyDataType< Matrix4x4 >()

◆ typeToPropertyDataType< SRTValue2D >()

◆ typeToPropertyDataType< SRTValue3D >()

◆ typeToPropertyDataType< string >()

Specialization of typeToPropertyDataType().

◆ typeToPropertyDataType< ResourceSharedPtr >()

◆ typeToPropertyDataType< void * >()

◆ typeToPropertyDataType< AbstractRangeSharedPtr >()

◆ to_string() [11/12]

string kanzi::to_string ( const ResourceID & id)
inline

Converts a ResourceID to a string.

Parameters
idID to convert.
Returns
String representation.

◆ operator==() [12/13]

bool kanzi::operator== ( string_view left,
FixedString right )
inline

◆ operator==() [13/13]

bool kanzi::operator== ( FixedString left,
string_view right )
inline

◆ operator!=() [12/13]

bool kanzi::operator!= ( string_view left,
FixedString right )
inline

◆ operator!=() [13/13]

bool kanzi::operator!= ( FixedString left,
string_view right )
inline

◆ to_string() [12/12]

string kanzi::to_string ( FixedString fixedString)
inline

◆ splitString() [1/2]

vector< string > kanzi::splitString ( const string & source,
const string & delimiter )

Splits string to tokens.

Use this function to split string source to substrings using delimiter. This function returns vector of resulting substrings. The substrings do not include delimiter.

Example:

splitString(string("123;456;"), ";") returns vector of strings: { "123", "456", "" }

Parameters
sourceThe string that will be split.
delimiterThe delimiter that is used for splitting.
Returns
The vector of substrings.

◆ splitString() [2/2]

vector< string_view > kanzi::splitString ( string_view source,
string_view delimiter )

Splits string view to tokens.

Use this function to split string view source to substrings using delimiter. This function returns vector of resulting substrings. The substrings do not include delimiter.

Prefer this function over splitString function above to avoid extra cost.

Example:

splitString(string_view("123;456;"), ";") returns vector of string views: { "123", "456", "" }

Parameters
sourceThe string view that will be split.
delimiterThe delimiter that is used for splitting.
Returns
The vector of substrings.

◆ toLower()

unsigned char kanzi::toLower ( unsigned char ch)

Wrapper for tolower() that returns unsigned char.

◆ trim()

string_view kanzi::trim ( string_view input)

boost::trim() implementation for string_view.

Use this function to remove all leading and trailing spaces from an input string. Kanzi modifies the input sequence in-place.

Parameters
inputThe string to trim.
Returns
The trimmed string.
Since
Kanzi 3.9.0

◆ resetStopWatch()

void kanzi::resetStopWatch ( StopWatch & stopWatch)
inline

Resets the stop watch.

This is a convenience function that calls StopWatch::getDeltaTime().

◆ getIntersection()

optional< TimeInterval > kanzi::getIntersection ( const TimeInterval & first,
const TimeInterval & second )

Gets intersection of two intervals.

Parameters
firstFirst interval.
secondSecond interval.
Returns
Intersection interval or empty optional if intervals are not intersecting.

◆ tupleForEach() [1/4]

template<size_t I = 0, typename Function , typename... TupleArgs>
enable_if_t< I==sizeof...(TupleArgs), void > kanzi::tupleForEach ( const tuple< TupleArgs... > & ,
Function &&  )

Applies a function to each element of a tuple (const version).

Template specialization of a case when tuple has 0 parameters (const version).

Template Parameters
FunctionFunction type.
TupleArgsTuple inner types.
Since
Kanzi 3.9.8

◆ tupleForEach() [2/4]

template<size_t I = 0, typename Function , typename... TupleArgs>
enable_if_t<(I< sizeof...(TupleArgs)), void > kanzi::tupleForEach ( const tuple< TupleArgs... > & tuple,
Function && function )

Applies a function to each element of a tuple (const version).

Does not return a value.

Template Parameters
FunctionFunction type.
TupleArgsTuple inner types.
Parameters
tupleTuple to which to apply the function.
functionFunction to apply.
Since
Kanzi 3.9.8

◆ tupleForEach() [3/4]

template<size_t I = 0, typename Function , typename... TupleArgs>
enable_if_t< I==sizeof...(TupleArgs), void > kanzi::tupleForEach ( tuple< TupleArgs... > & ,
Function &&  )

Applies a function to each element of a tuple.

Template specialization of a case when tuple has 0 parameters (const version).

Template Parameters
FunctionFunction type.
TupleArgsTuple inner types.
Since
Kanzi 3.9.8

◆ tupleForEach() [4/4]

template<size_t I = 0, typename Function , typename... TupleArgs>
enable_if_t<(I< sizeof...(TupleArgs)), void > kanzi::tupleForEach ( tuple< TupleArgs... > & tuple,
Function && function )

Applies a function to each element of a tuple.

Does not return a value.

Template Parameters
FunctionFunction type.
TupleArgsTuple inner types.
Parameters
tupleTuple to which to apply the function.
functionFunction to apply.
Since
Kanzi 3.9.8

◆ handleDefaultExceptions()

void kanzi::handleDefaultExceptions ( JNIEnv * env)

Handle the top level Java and native exceptions and rethrow via the JNI.

◆ javaErrorCallback()

void kanzi::javaErrorCallback ( void * ctx,
kanzi::interop::ErrorCode code,
const char * message )

Callback function that is used to pass exceptions to Java.

◆ getJniLibrary()

KANZI_JVM_API JniLibrary * kanzi::getJniLibrary ( )

Gets a set of function pointers that represent the JNI library.

On Windows, this function loads a dynamic library named jvm from the active PATH. If not found, it will fall back to use JAVA_HOME to find the library.

◆ getUIAssetDataSize()

size_t kanzi::getUIAssetDataSize ( )

Gets size of UI asset data.

Returns
Data size in bytes.

◆ getUIAssetData()

const byte * kanzi::getUIAssetData ( )

Gets UI asset data.

Returns
Pointer to UI asset data.

◆ registerUIAssets()

void kanzi::registerUIAssets ( Domain * domain)

Registers build-in UI assets in resource manager of domain so they can be acquired at runtime.

Parameters
domainThe domain where to register the UI assets.

◆ ActivityStatusAnimationFinishedHandler::sendMessages< ActivityConcept::Status::Inactive >()

◆ ActivityStatusAnimationFinishedHandler::sendMessages< ActivityConcept::Status::Activating >()

◆ ActivityStatusAnimationFinishedHandler::sendMessages< ActivityConcept::Status::Active >()

◆ ActivityStatusAnimationFinishedHandler::sendMessages< ActivityConcept::Status::Deactivating >()

◆ doListBoxArrange() [1/2]

void kanzi::doListBoxArrange ( Node3D & node)
inline

◆ doListBoxArrange() [2/2]

void kanzi::doListBoxArrange ( Node2D & node)
inline

◆ messagingAndChangeSignaling()

void kanzi::messagingAndChangeSignaling ( DerivedClassType & m_derivedClass,
optional< float > & m_lastHitPointValue,
CurvePointType & m_lastHitPoint,
CurvePointType & closestCurvePoint,
float distanceAlongCurve,
float shortestDistance,
InputManipulator::InputMessageArguments & message )
inline

Variable Documentation

◆ ConfigurationKeyEGLGraphicsFormatID

const string kanzi::ConfigurationKeyEGLGraphicsFormatID
extern

◆ ConfigurationKeyEGLContextClientVersion

const string kanzi::ConfigurationKeyEGLContextClientVersion
extern

◆ ConfigurationKeyEGLSurfaceType

const string kanzi::ConfigurationKeyEGLSurfaceType
extern

◆ ConfigurationKeyEGLEnumerateConfigurations

const string kanzi::ConfigurationKeyEGLEnumerateConfigurations
extern

◆ ConfigurationKeyWGLGraphicsFormatID

const string kanzi::ConfigurationKeyWGLGraphicsFormatID
extern

◆ ConfigurationKeySurfaceColorSpace

const string kanzi::ConfigurationKeySurfaceColorSpace
extern

◆ ConfigurationKeyWin32EnumerateDisplays

const string kanzi::ConfigurationKeyWin32EnumerateDisplays
extern

◆ ConfigurationKeyQnxPipelineID

const string kanzi::ConfigurationKeyQnxPipelineID
extern

◆ ConfigurationKeyQnxEnumerateDisplays

const string kanzi::ConfigurationKeyQnxEnumerateDisplays
extern

◆ ConfigurationKeyQnxContextType

const string kanzi::ConfigurationKeyQnxContextType
extern

◆ ConfigurationKeyQnxEnableSlogger2

const string kanzi::ConfigurationKeyQnxEnableSlogger2
extern

◆ ConfigurationKeyQnxSlogger2VerbosityLevel

const string kanzi::ConfigurationKeyQnxSlogger2VerbosityLevel
extern

◆ ConfigurationValueSlogger2VerbosityLevelShutdown

const string kanzi::ConfigurationValueSlogger2VerbosityLevelShutdown
extern

◆ ConfigurationValueSlogger2VerbosityLevelCritical

const string kanzi::ConfigurationValueSlogger2VerbosityLevelCritical
extern

◆ ConfigurationValueSlogger2VerbosityLevelError

const string kanzi::ConfigurationValueSlogger2VerbosityLevelError
extern

◆ ConfigurationValueSlogger2VerbosityLevelWarning

const string kanzi::ConfigurationValueSlogger2VerbosityLevelWarning
extern

◆ ConfigurationValueSlogger2VerbosityLevelNotice

const string kanzi::ConfigurationValueSlogger2VerbosityLevelNotice
extern

◆ ConfigurationValueSlogger2VerbosityLevelInfo

const string kanzi::ConfigurationValueSlogger2VerbosityLevelInfo
extern

◆ ConfigurationValueSlogger2VerbosityLevelDebug1

const string kanzi::ConfigurationValueSlogger2VerbosityLevelDebug1
extern

◆ ConfigurationValueSlogger2VerbosityLevelDebug2

const string kanzi::ConfigurationValueSlogger2VerbosityLevelDebug2
extern

◆ ConfigurationKeyQnxSlogger2MaxRetries

const string kanzi::ConfigurationKeyQnxSlogger2MaxRetries
extern

◆ SystemConfigurationKeyMmapMode

const string kanzi::SystemConfigurationKeyMmapMode
extern

◆ SystemConfigurationValueMmapLazy

const string kanzi::SystemConfigurationValueMmapLazy
extern

◆ SystemConfigurationValueMmapEager

const string kanzi::SystemConfigurationValueMmapEager
extern

◆ SystemConfigurationValueMmapDefault

const string kanzi::SystemConfigurationValueMmapDefault
extern

◆ ConfigurationKeyDefaultWindowX

const string kanzi::ConfigurationKeyDefaultWindowX
extern

Key to access the default window X coordinate parameter of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultWindowY

const string kanzi::ConfigurationKeyDefaultWindowY
extern

Key to access the default window Y coordinate parameter of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultWindowWidth

const string kanzi::ConfigurationKeyDefaultWindowWidth
extern

Key to access the default window width parameter of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultWindowHeight

const string kanzi::ConfigurationKeyDefaultWindowHeight
extern

Key to access the default window height parameter of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultWindowOrder

const string kanzi::ConfigurationKeyDefaultWindowOrder
extern

Key to access the default window order parameter of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultWindowStyle

const string kanzi::ConfigurationKeyDefaultWindowStyle
extern

Key to access the default window style of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultWindowTitle

const string kanzi::ConfigurationKeyDefaultWindowTitle
extern

Key to access the default window title of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultWindowClassName

const string kanzi::ConfigurationKeyDefaultWindowClassName
extern

Key to access the default window class name of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultDisplayIndex

const string kanzi::ConfigurationKeyDefaultDisplayIndex
extern

Key to access the default display index of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultSurfaceBitsRed

const string kanzi::ConfigurationKeyDefaultSurfaceBitsRed
extern

Key to access the default surface bits red of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultSurfaceBitsGreen

const string kanzi::ConfigurationKeyDefaultSurfaceBitsGreen
extern

Key to access the default surface bits green of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultSurfaceBitsBlue

const string kanzi::ConfigurationKeyDefaultSurfaceBitsBlue
extern

Key to access the default surface bits blue of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultSurfaceBitsAlpha

const string kanzi::ConfigurationKeyDefaultSurfaceBitsAlpha
extern

Key to access the default surface bits alpha of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultSurfaceType

const string kanzi::ConfigurationKeyDefaultSurfaceType
extern

Key to access the default surface type of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultSurfaceBitsDepth

const string kanzi::ConfigurationKeyDefaultSurfaceBitsDepth
extern

Key to access the default surface bits depth of the system configuration.

Since
Kanzi 3.9.7

◆ ConfigurationKeyDefaultSurfaceBitsStencil

const string kanzi::ConfigurationKeyDefaultSurfaceBitsStencil
extern

Key to access the default surface bits stencil of the system configuration.

Since
Kanzi 3.9.8

◆ ConfigurationKeyDefaultSurfaceSamplesAntialiasing

const string kanzi::ConfigurationKeyDefaultSurfaceSamplesAntialiasing
extern

Key to access the default surface anti-aliasing sample count of the system configuration.

Since
Kanzi 3.9.8

◆ ConfigurationKeyEGLIMGContextPriority

const string kanzi::ConfigurationKeyEGLIMGContextPriority
extern

Key to access the EGL IMG context priority of the system configuration.

Since
Kanzi 3.9.8

◆ ConfigurationKeyWaylandShell

const string kanzi::ConfigurationKeyWaylandShell
extern

Key to access the Wayland shell of the system configuration.

Since
Kanzi 3.9.8

◆ ConfigurationKeyWaylandInputMode

const string kanzi::ConfigurationKeyWaylandInputMode
extern

Key to access the Wayland immediate input mode of the system configuration.

Since
Kanzi 3.9.9

◆ ConfigurationKeyWaylandIviSurfaceId

const string kanzi::ConfigurationKeyWaylandIviSurfaceId
extern

Key to access the IVI surface ID of the system configuration.

Since
Kanzi 3.9.8

◆ ConfigurationKeyWaylandIviLayerId

const string kanzi::ConfigurationKeyWaylandIviLayerId
extern

Key to access the IVI layer ID of the system configuration.

Since
Kanzi 3.9.8

◆ ConfigurationKeyWaylandIviLayerVisibility

const string kanzi::ConfigurationKeyWaylandIviLayerVisibility
extern

Key to access the IVI layer visibility of the system configuration.

Since
Kanzi 3.9.8

◆ ConfigurationKeyWaylandIviSurfaceVisibility

const string kanzi::ConfigurationKeyWaylandIviSurfaceVisibility
extern

Key to access the IVI surface visibility of the system configuration.

Since
Kanzi 3.9.8

◆ ConfigurationKeyWaylandIviLayerOpacity

const string kanzi::ConfigurationKeyWaylandIviLayerOpacity
extern

Key to access the IVI layer opacity of the system configuration.

Since
Kanzi 3.9.8

◆ ConfigurationKeyWaylandIviSurfaceOpacity

const string kanzi::ConfigurationKeyWaylandIviSurfaceOpacity
extern

Key to access the IVI surface opacity of the system configuration.

Since
Kanzi 3.9.8

◆ s_expressionValidatorBaseValueEngineInternal

constexpr uint16_t kanzi::s_expressionValidatorBaseValueEngineInternal
staticconstexpr

Expression operations from this index upwards are internal to Kanzi Engine.

Operation values 256 - 511. and not known about by Studio or used in the shared binary format.

◆ s_expressionValidatorBaseValueProcessorInternal

constexpr uint16_t kanzi::s_expressionValidatorBaseValueProcessorInternal
staticconstexpr

Binding processor operations from this index upwards are special cases in Kanzi Engine.

Operation values 512 - 767. The low byte of the value is used as the index of the associated validator.

◆ NativeDeploymentTargetDefault

const NativeDeploymentTarget kanzi::NativeDeploymentTargetDefault
extern

The default native deployment target.

◆ GraphicsBlendModeOpaque

constexpr int kanzi::GraphicsBlendModeOpaque
constexpr

Opaque blend mode.

Disables blending. Draws the source pixels.

Since
Kanzi 3.9.1 changed from enumerator to integer and value changed.

◆ GraphicsBlendModeAlpha

constexpr int kanzi::GraphicsBlendModeAlpha
constexpr

Legacy blend mode.

Multiplies both source color and source alpha with source alpha. Does not produce premultiplied output. For non-premultiplied content use GraphicsBlendModeMixedAlpha.

Since
Kanzi 3.9.1 changed from enumerator to integer and value changed.

◆ GraphicsBlendModeAdditive

constexpr int kanzi::GraphicsBlendModeAdditive
constexpr

Additive blend mode.

Adds the source pixels to the destination pixels.

Since
Kanzi 3.9.1 changed from enumerator to integer and value changed.

◆ GraphicsBlendModePremultipliedAlpha

constexpr int kanzi::GraphicsBlendModePremultipliedAlpha
constexpr

Premultiplied Alpha blend mode - the default and recommend mode for alpha blending.

Blends the source pixels on top of the destination pixels. This mode expects premultiplied alpha RGBA in the source pixels.

Since
Kanzi 3.9.1 changed from enumerator to integer and value changed.

◆ GraphicsBlendModeMixedAlpha

constexpr int kanzi::GraphicsBlendModeMixedAlpha
constexpr

Mixed Alpha blend mode.

Blends the source pixels on top of the destination pixels. This mode expects non-premultiplied alpha RGBA in the source pixels.

Since
Kanzi 3.9.1 changed from enumerator to integer and value changed.

◆ GraphicsBlendModeMultiply

constexpr int kanzi::GraphicsBlendModeMultiply
constexpr

Multiply blend mode.

Multiplies the source and destination pixels.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeScreen

constexpr int kanzi::GraphicsBlendModeScreen
constexpr

Screen blend mode.

Adds the source and destination pixels and subtracts from the result the product of the source and destination.

Since
Kanzi 3.9.1.

◆ GraphicsBlendModeClear

constexpr int kanzi::GraphicsBlendModeClear
constexpr

Clear blend mode.

Clears the destination pixels to transparent black.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeExclusiveOr

constexpr int kanzi::GraphicsBlendModeExclusiveOr
constexpr

Exclusive Or blend mode.

Draws the non-overlapping source and destination pixels. In the overlapping source and destination pixels reduces the source alpha by the inverse of the destination alpha, and the destination alpha by the inverse of the source alpha, then merges the pixels.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeSourceAtop

constexpr int kanzi::GraphicsBlendModeSourceAtop
constexpr

Source Atop blend mode.

Discards those source pixels that do not cover destination pixels, and draws the rest of the source pixels over destination pixels.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeSourceIn

constexpr int kanzi::GraphicsBlendModeSourceIn
constexpr

Source In blend mode.

Draws those source pixels that cover destination pixels, and discards all destination pixels.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeSourceOut

constexpr int kanzi::GraphicsBlendModeSourceOut
constexpr

Source Out blend mode.

Draws the source pixels with alpha reduced by the inverse of the destination alpha, and discards all destination pixels.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeDestinationAtop

constexpr int kanzi::GraphicsBlendModeDestinationAtop
constexpr

Destination Atop blend mode.

Discards those destination pixels that are not covered by source pixels, and draws the rest of the destination pixels over source pixels.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeDestinationIn

constexpr int kanzi::GraphicsBlendModeDestinationIn
constexpr

Destination In blend mode.

Draws only those destination pixels that intersect with the source pixels, and discards all source pixels.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeDestinationOut

constexpr int kanzi::GraphicsBlendModeDestinationOut
constexpr

Destination Out blend mode.

Draws the destination pixels with alpha reduced by the inverse of the source alpha, and discards all source pixels.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeDestinationOver

constexpr int kanzi::GraphicsBlendModeDestinationOver
constexpr

Destination Over blend mode.

Draws the destination pixels over the source pixels.

Since
Kanzi 3.9.1

◆ GraphicsBlendModeAdvancedMultiply

constexpr int kanzi::GraphicsBlendModeAdvancedMultiply
constexpr

Advanced multiply blend mode.

Multiplies the colors of the source and destination, resulting in a darker color.

Since
Kanzi 3.9.6

◆ GraphicsBlendModeOverlay

constexpr int kanzi::GraphicsBlendModeOverlay
constexpr

Overlay blend mode.

Multiplies or screens the colors, depending on the destination color. Where the destination is light, the source becomes lighter, and where the destination is dark, the source becomes darker. This mode preserves the highlights and shadows in the destination.

Since
Kanzi 3.9.6

◆ GraphicsBlendModeDarken

constexpr int kanzi::GraphicsBlendModeDarken
constexpr

Darken blend mode.

Compares the colors of the destination and source and selects the darker one.

Since
Kanzi 3.9.6

◆ GraphicsBlendModeLighten

constexpr int kanzi::GraphicsBlendModeLighten
constexpr

Lighten blend mode.

Compares the colors of the destination and source and selects the lighter one.

Since
Kanzi 3.9.6

◆ GraphicsBlendModeColorBurn

constexpr int kanzi::GraphicsBlendModeColorBurn
constexpr

Color Burn blend mode.

Darkens the destination to reflect the color of the source, producing a result with higher contrast, saturated mid-tones, and reduced highlights. Blending with white produces no change.

Since
Kanzi 3.9.6

◆ GraphicsBlendModeColorDodge

constexpr int kanzi::GraphicsBlendModeColorDodge
constexpr

Color Dodge blend mode.

Lightens the destination to reflect the color of the source, producing a result with lower contrast, saturated mid-tones, and blown highlights. Blending with black produces no change.

Since
Kanzi 3.9.6

◆ GraphicsBlendModeHardLight

constexpr int kanzi::GraphicsBlendModeHardLight
constexpr

Hard Light blend mode.

Multiplies or screens the colors, depending on the source color:

  • A source color lighter than 50% gray lightens the destination as if screening it.
  • A source color darker than 50% gray darkens the destination as if multiplying it.
Since
Kanzi 3.9.6

◆ GraphicsBlendModeSoftLight

constexpr int kanzi::GraphicsBlendModeSoftLight
constexpr

Soft Light blend mode.

Darkens or lightens the colors, depending on the source color:

  • A source color lighter than 50% gray lightens the destination as if dodging it.
  • A source color darker than 50% gray darkens the destination as if burning it.
Since
Kanzi 3.9.6

◆ GraphicsBlendModeDifference

constexpr int kanzi::GraphicsBlendModeDifference
constexpr

Difference blend mode.

Subtracts either the source color from the destination color or the other way around, depending on which one is brighter. White source color inverts the destination color. Black source color produces no change.

Since
Kanzi 3.9.6

◆ GraphicsBlendModeExclusion

constexpr int kanzi::GraphicsBlendModeExclusion
constexpr

Exclusion blend mode.

Creates an effect that is similar to the Difference mode but lower in contrast. White source color inverts the destination color. Black source color produces no change.

Since
Kanzi 3.9.6

◆ GraphicsBlendModeHSLHue

constexpr int kanzi::GraphicsBlendModeHSLHue
constexpr

HSL Hue blend mode.

Uses:

  • Hue of the source
  • Luminosity and saturation of the destination
Since
Kanzi 3.9.6

◆ GraphicsBlendModeHSLSaturation

constexpr int kanzi::GraphicsBlendModeHSLSaturation
constexpr

HSL Saturation blend mode.

Uses:

  • Saturation of the source
  • Hue and luminosity of the destination
Since
Kanzi 3.9.6

◆ GraphicsBlendModeHSLColor

constexpr int kanzi::GraphicsBlendModeHSLColor
constexpr

HSL Color blend mode.

Uses:

  • Hue and saturation of the source
  • Luminosity of the destination
Since
Kanzi 3.9.6

◆ GraphicsBlendModeHSLLuminosity

constexpr int kanzi::GraphicsBlendModeHSLLuminosity
constexpr

HSL Luminosity blend mode.

Uses:

  • Luminosity of the source
  • Hue and saturation of the destination
Since
Kanzi 3.9.6

◆ InvalidTouchId

constexpr unsigned int kanzi::InvalidTouchId
constexpr

Invalid touch point identifier.

◆ c_keyRepeatDelay

constexpr auto kanzi::c_keyRepeatDelay
constexpr

Specifies the time in milliseconds Kanzi waits before it detects a key-repeat gesture.

◆ c_keyRepeatInterval

constexpr auto kanzi::c_keyRepeatInterval
constexpr

Specifies the time in milliseconds between the key-press repetitions.

◆ InputStage

Stage kanzi::InputStage
extern

Stage for handling input events.

◆ UserStage

Stage kanzi::UserStage
extern

Stage for executing your application code.

Includes:

  • Task dispatcher tasks
  • Resource deployment
  • kzb file and prefab loading

◆ AnimateStage

Stage kanzi::AnimateStage
extern

Stage for ticking animations.

◆ LayoutStage

Stage kanzi::LayoutStage
extern

Stage for laying out the nodes.

◆ RenderStage

Stage kanzi::RenderStage
extern

Stage for rendering the nodes.

◆ PresentStage

Stage kanzi::PresentStage
extern

Stage for presenting the nodes.

◆ invalidEventHandle

const NativeEventHandle kanzi::invalidEventHandle
extern

◆ g_platformMmapMode

MmapMode kanzi::g_platformMmapMode
extern

Globally available chosen mmap() strategy.

◆ Slog2DefaultPageCount

const int kanzi::Slog2DefaultPageCount
extern

◆ Slog2UnlimitedRetries

const uint32_t kanzi::Slog2UnlimitedRetries
extern

◆ ThemeRed

const ColorRGBA kanzi::ThemeRed
extern

◆ ThemeGreen

const ColorRGBA kanzi::ThemeGreen
extern

◆ ThemeBlue

const ColorRGBA kanzi::ThemeBlue
extern

◆ ThemeYellow

const ColorRGBA kanzi::ThemeYellow
extern

◆ ThemeGray

const ColorRGBA kanzi::ThemeGray
extern

◆ ThemeOrange

const ColorRGBA kanzi::ThemeOrange
extern

◆ luaRequirements

const string_view kanzi::luaRequirements
extern

◆ luaCoreLib

const array<string_view, 471> kanzi::luaCoreLib
extern

◆ cursorWidth

constexpr auto kanzi::cursorWidth
constexpr

◆ cursorColor

const auto kanzi::cursorColor

◆ selectionIndicatorRadius

constexpr auto kanzi::selectionIndicatorRadius
constexpr

◆ selectionCaretHitTestAreaWidth

constexpr auto kanzi::selectionCaretHitTestAreaWidth
constexpr

Sets on the left and right side of each text selection caret the width of the hit test area for that caret in pixels.